Skip to content

Commit fe742b4

Browse files
author
Joshua Hoblitt
committed
fix a few README typos + minor formatting
1 parent f79fb87 commit fe742b4

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Puppet nsstools Module
88
1. [Overview](#overview)
99
2. [Description](#description)
1010
3. [Usage](#usage)
11-
* [_Security Considerations_](#security_considerations)
11+
* [__Security Considerations__](#security_considerations)
1212
* [Classes](#classes)
1313
* [Types](#types)
1414
* [Functions](#functions)
@@ -38,7 +38,7 @@ Tools](https://developer.mozilla.org/en-US/docs/NSS/tools) and
3838
The latter is some what ironically required as although the NSS suite is
3939
intended to be used in place of OpenSSL, it mandates the usage of
4040
[`PKCS#12`](https://en.wikipedia.org/wiki/PKCS_12) format files for certain
41-
operations. This is unfortunate is it appears to provide no utility for
41+
operations. This is unfortunate as it appears to provide no utility for
4242
converting between the ASCII
4343
[`.pem`](https://serverfault.com/questions/9708/what-is-a-pem-file-and-how-does-it-differ-from-other-openssl-generated-key-file)
4444
format popular for X.509 certificates and `PKCS#12`. Thus, OpenSSL is required
@@ -53,7 +53,7 @@ database.
5353
Usage
5454
-----
5555

56-
## _Security Considerations_
56+
## __Security Considerations__
5757

5858
This module creates an on-disk file in the path of the NSS database named
5959
`nss-password.txt`. This file contains the password used to encrypt private
@@ -76,28 +76,28 @@ nsstools::create { '/etc/dirsrv/slapd-ldap1':
7676
}
7777
7878
nsstools::add_cert_and_key{ 'Server-Cert':
79-
certdir => '/etc/dirsrv/slapd-ldap1',
80-
cert => '/tmp/foo.pem',
81-
key => '/tmp/foo.key',
79+
certdir => '/etc/dirsrv/slapd-ldap1',
80+
cert => '/tmp/foo.pem',
81+
key => '/tmp/foo.key',
8282
}
8383
8484
nsstools::add_cert { 'AlphaSSL CA':
85-
certdir => '/etc/dirsrv/slapd-ldap1',
86-
cert => '/tmp/alphassl_intermediate.pem',
85+
certdir => '/etc/dirsrv/slapd-ldap1',
86+
cert => '/tmp/alphassl_intermediate.pem',
8787
}
8888
8989
nsstools::add_cert { 'GlobalSign Root CA':
90-
certdir => '/etc/dirsrv/slapd-ldap1',
91-
cert => '/tmp/globalsign_root.pem',
90+
certdir => '/etc/dirsrv/slapd-ldap1',
91+
cert => '/tmp/globalsign_root.pem',
9292
}
9393
```
9494

9595
## Classes
9696

9797
### `nsstools`
9898

99-
This class is required by all of this modules types. It owns installation of
100-
the `nss-tools` package.
99+
This class is required by all of this module's types. It "owns" installation
100+
of the `nss-tools` package.
101101

102102
```puppet
103103
# defaults
@@ -106,7 +106,7 @@ class { 'nsstools':
106106
}
107107
```
108108

109-
* `require\_openssl`
109+
* `require_openssl`
110110

111111
`Bool`. Defaults to: `true`
112112

@@ -141,7 +141,7 @@ nsstools::create { <title>:
141141
`String` Required
142142

143143
Password to set on the database. There are
144-
[_Security Considerations_](#security_considerations) to be aware of with
144+
[__Security Considerations__](#security_considerations) to be aware of with
145145
this parameter.
146146

147147
* `certdir`
@@ -170,11 +170,11 @@ nsstools::create { <title>:
170170

171171
`String` Defaults to: `0600`
172172

173-
* `certdir\_mode`
173+
* `certdir_mode`
174174

175175
`String` Defaults to: `0700`
176176

177-
### `add\_cert`
177+
### `add_cert`
178178

179179
Insert a certificate into an existing NSS database.
180180

@@ -215,7 +215,7 @@ nsstools::add_cert { <title>:
215215

216216
The certificate trust attributes in the database.
217217

218-
### `add\_cert\_and\_key`
218+
### `add_cert_and_key`
219219

220220
Insert a certificate and it's associated private key an existing NSS database.
221221

@@ -259,7 +259,7 @@ nsstools::add_cert_and_key { <title>:
259259

260260
## Functions
261261

262-
### `nsstools\_add\_cert`
262+
### `nsstools_add_cert`
263263

264264
Iterates over a hash of cert nickname/path pairs (key/value) and creates
265265
nsstools::add_cert resources.

0 commit comments

Comments
 (0)