Skip to content

Commit 0a29ac9

Browse files
author
Ed Costello
committed
spellcheck, typos
1 parent 460eaee commit 0a29ac9

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

draft/core/security.txt

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Authentication and Security
66

77
As with all software running in a networked environment,
88
administrators of MongoDB must consider security and risk
9-
exposures for a MongoDB deployment. There are no magic solution for risk
9+
exposures for a MongoDB deployment. There are no magic solutions for risk
1010
mitigation, and maintaining a secure MongoDB deployment is an ongoing
1111
process. This document takes a *Defense in Depth* approach to securing
1212
MongoDB deployments, and addresses a number of different methods for
@@ -80,7 +80,8 @@ By default, listens for connections on the following ports:
8080

8181
``27017``
8282
This is the default port :program:`mongod` and :program:`mongos`
83-
instances. You can change this port with :setting:`port`.
83+
instances. You can change this port with :setting:`port` or
84+
:option:`--port <mongod --port>`.
8485

8586
``27018``
8687
This is the default port when running with :option:`--shardsvr
@@ -89,7 +90,7 @@ By default, listens for connections on the following ports:
8990

9091
``27019``
9192
This is the default port when running with :option:`--configsvr
92-
<mongod --configsvr>` runtime operation or :setting:`commonsvr`
93+
<mongod --configsvr>` runtime operation or :setting:`configsvr`
9394
setting.
9495

9596
``28017``
@@ -278,7 +279,7 @@ authentication system:
278279

279280
- When setting up authentication for the first time you must either:
280281

281-
a. add at least one user to the ``admin`` database before starting
282+
#. add at least one user to the ``admin`` database before starting
282283
the :program:`mongod` instance with :setting:`auth`.
283284

284285
#. add the first user to the ``admin`` database when connected to
@@ -291,10 +292,10 @@ authentication system:
291292

292293
Consider the
293294
:doc:`/tutorial/use-authentication-to-control-access-to-mongodb`
294-
document which outlines procedures for configuraing and maintaing
295+
document which outlines procedures for configuring and maintaining
295296
users and access with MongoDB's authentication system.
296297

297-
.. [#sharded-localhost] Becasue of :issue:`SERVER-6591`, you cannot
298+
.. [#sharded-localhost] Because of :issue:`SERVER-6591`, you cannot
298299
add the first user to a sharded cluster using the ``localhost``
299300
connection in 2.2. If you are running a 2.2 sharded cluster, and
300301
want to enable authentication, you must deploy the cluster and add
@@ -304,19 +305,19 @@ users and access with MongoDB's authentication system.
304305
Interfaces
305306
----------
306307

307-
Simply limiting access to a :program:`mongod` is not a sufficent for
308-
totally controling risk expsorure. Consider the recomendaitons in the
308+
Simply limiting access to a :program:`mongod` is not a sufficient for
309+
totally controlling risk exposure. Consider the recommendations in the
309310
following section, for limiting exposure other interface-related
310311
risks.
311312

312-
JavaScript and the Security of the ``mongo`` Sell
313-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
313+
JavaScript and the Security of the ``mongo`` Shell
314+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
314315

315316
Be aware of the following capabilities and behaviors of the
316317
:program:`mongo` shell:
317318

318319
- :program:`mongo` will evaluate a ``.js`` file passed to the
319-
:option:`mongo --eval` operation. command. The :program:`mongo`
320+
:option:`mongo --eval` option. The :program:`mongo`
320321
shell does not validate the input of JavaScript input to
321322
:option:`--eval <mongo --eval>`.
322323

@@ -325,25 +326,25 @@ Be aware of the following capabilities and behaviors of the
325326
:option:`mongo --norc`` option.
326327

327328
On Linux and Unix systems, :program:`mongo` reads the
328-
``.mongorc.js`` file from ``$HOME/.mongorc.js``
329-
(i.e. ``~/.mongorc.js``), and Windows :program:`mongo` reads the
330-
``.mongorc.js`` file from ``%HOME%\.mongorc.js`` or
331-
``%HOMEDRIVE%\%HOMEPATH%\.mongorc.js``.
329+
:file:`.mongorc.js` file from :file:`{$HOME}/.mongorc.js`
330+
(i.e. :file:`~/.mongorc.js`), and Windows :program:`mongo.exe` reads the
331+
:file:`.mongorc.js` file from :file:`{%HOME%}\.mongorc.js` or
332+
:file:`{%HOMEDRIVE%}\{%HOMEPATH%}\.mongorc.js`.
332333

333334
HTTP Status Interface
334335
~~~~~~~~~~~~~~~~~~~~~
335336

336337
The HTTP status interface provides a web-based interface that includes
337338
a variety of operational data, logs, and status reports regarding the
338339
:program:`mongod` or :program:`mongos` instance. The HTTP interface is
339-
always avalible on the the port numbered ``1000`` greater than the
340+
always available on the the port numbered ``1000`` greater than the
340341
primary :program:`mongod` port. By default this is ``28017``, but is
341342
indirectly using the :setting:`port` option which allows you to
342343
configure the primary :program:`mongod` port.
343344

344345
Without the :setting:`rest` setting, this interface is entirely
345-
read-only, and limited in scope; nevertheless, this iterface may
346-
represent an exposure. To diable the HTTP interface, set the
346+
read-only, and limited in scope; nevertheless, this interface may
347+
represent an exposure. To disable the HTTP interface, set the
347348
:setting:`nohttpinterface` run time option or the
348349
:option:`--nohttpinterface <mongod --nohttpinterface>` command line
349350
option.
@@ -372,15 +373,15 @@ the REST API interface:
372373
Data Encryption
373374
---------------
374375

375-
To support audit requirements, you may need to envrypt data stored in
376+
To support audit requirements, you may need to encrypt data stored in
376377
MongoDB. For best results you can encrypt this data in the application
377-
layer, by encrytping the content of fields that hold secure data.
378+
layer, by encrypting the content of fields that hold secure data.
378379

379380
Additionally, `10gen`_ has a `partnership`_ with `Gazzang`_ to encrypt
380-
and secure senitive data within MongoDB. The solution encrypts data in
381+
and secure sensitive data within MongoDB. The solution encrypts data in
381382
real time and Gazzang provides advanced key management that ensures
382-
only authorized processes and can access this data. THe Gazzang
383-
software ensures that the cryptogrpahic keys rmeain safe and ensures
383+
only authorized processes and can access this data. The Gazzang
384+
software ensures that the cryptographic keys remain safe and ensures
384385
compliance with standards including HIPPA, PCI-DSS, and FERPA. For
385386
more information consider the following resources:
386387

draft/tutorial/use-authentication-to-control-access-to-mongodb.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ configuration, i.e. authentication does not apply to users
173173
logging into `mongod` on localhost.
174174

175175

176-
.. versionadded:: 2.2
176+
.. versionchanged:: 2.2
177177

178178
The trust model changed for MongoDB 2.2. If :program:`mongod`
179179
is started with the :option:`--auth <mongod --auth>` option then
@@ -218,7 +218,7 @@ database when running with authentication enabled:
218218
* - Localhost
219219
- Yes
220220
- Yes
221-
* - Locahost
221+
* - Localhost
222222
- No
223223
- No
224224
* - Remote
@@ -348,9 +348,9 @@ characters from the administrator setting up the cluster.
348348

349349
If you run mongod with `-v`, the key will be printed in the log.
350350

351-
The keyfile must be owned and readable by the account running the
351+
The keyFile must be owned and readable by the account running the
352352
MongoDB instance. The MongoDB instance will exit with an error if
353-
the keyfile is readable, writeable or executable by any other
353+
the keyFile is readable, writeable or executable by any other
354354
account on the system.
355355

356356
Currently, permissions are not checked by :program:`mongod.exe` on Windows.

0 commit comments

Comments
 (0)