| 1 |
.TH lprng_certs 1 2006-12-09 "LPRng" "lprng_certs command" |
| 2 |
.SH NAME |
| 3 |
lprng_certs \- lprng SSL certificate management |
| 4 |
.SH SYNOPSIS |
| 5 |
.B |
| 6 |
.nf |
| 7 |
lprng_certs option |
| 8 |
Options: |
| 9 |
init - make directory structure |
| 10 |
newca - make new root CA |
| 11 |
defaults - set new default values for certs |
| 12 |
gen - generate user, server, or signing cert |
| 13 |
index [dir] - index cert files |
| 14 |
verify [cert] - verify cert file |
| 15 |
encrypt keyfile |
| 16 |
- set or change keyfile password |
| 17 |
.nf |
| 18 |
.SH DESCRIPTION |
| 19 |
.PP |
| 20 |
The |
| 21 |
.B lprng_certs |
| 22 |
program is used to manage SSL certificates for the LPRng software. |
| 23 |
There SSL certificate structure consists of a hierarchy of |
| 24 |
certificates. |
| 25 |
The LPRng software assumes that the following types of certificates |
| 26 |
will be used: |
| 27 |
.IP "CA or root" |
| 28 |
A top level or self-signed certificate. |
| 29 |
.IP "signing" |
| 30 |
A certificate that can be used to sign other certificates. |
| 31 |
This is signed by the root CA or another signing certificate. |
| 32 |
.IP "user" |
| 33 |
A certificate used by a user to identify themselves to the |
| 34 |
lpd server. |
| 35 |
.IP "server" |
| 36 |
A certificate used by the |
| 37 |
.I lpd |
| 38 |
server to identify themselves to the |
| 39 |
user or other |
| 40 |
.I lpd |
| 41 |
servers. |
| 42 |
.SH "Signing Certificates" |
| 43 |
.PP |
| 44 |
All of the signing certificates, |
| 45 |
including the root certificate (root CA), |
| 46 |
/etc/lprng/ssl.ca/ca.crt, |
| 47 |
are in the same directory as the root CA file. |
| 48 |
Alternately, |
| 49 |
all of the signing certs can be concatenated and put into a single file, |
| 50 |
which by convention is assumed to have the same name as the root CA |
| 51 |
file, |
| 52 |
/etc/lprng/ssl.ca/ca.crt. |
| 53 |
The |
| 54 |
.BR ssl_ca_file , |
| 55 |
.BR ssl_ca_path , |
| 56 |
and |
| 57 |
.BR ssl_ca_key |
| 58 |
printcap and configuration options can be used to specify |
| 59 |
the locations of the root CA files, |
| 60 |
a directory containing the signing certificate files, |
| 61 |
and the private key file for the root CA file respectively. |
| 62 |
.PP |
| 63 |
The root certificate (root CA file) |
| 64 |
/etc/lprng/ssl.ca/ca.crt |
| 65 |
has a private key file |
| 66 |
/etc/lprng/ssl.ca/ca.key |
| 67 |
as well. |
| 68 |
By convention, |
| 69 |
the private keys for the other signing certificate files are stored in the |
| 70 |
certificate file. |
| 71 |
.PP |
| 72 |
The OpenSSL software requires that this directory |
| 73 |
also contain a set of hash files which are, |
| 74 |
in effect, |
| 75 |
links to these files. |
| 76 |
.PP |
| 77 |
By default, all signing certificates are assumed to be |
| 78 |
in the same directory as the root certificate. |
| 79 |
.SH "Server Certificates" |
| 80 |
.PP |
| 81 |
The certificate used by the |
| 82 |
.I lpd |
| 83 |
server are kept in another |
| 84 |
directory. |
| 85 |
These files do not need to have hash links to them. |
| 86 |
By convention, |
| 87 |
the private keys for these certificate files are stored in the |
| 88 |
certificate file. |
| 89 |
The server certificate file |
| 90 |
is specified by the |
| 91 |
.B ssl_server_cert |
| 92 |
and has the default value |
| 93 |
/etc/lprng/ssl.server/server.crt. |
| 94 |
This file contains the cert and private key. |
| 95 |
The server certificate password file is specified by the |
| 96 |
.B ssl_server_password |
| 97 |
option with the default value |
| 98 |
|
| 99 |
and |
| 100 |
contains the password used to decrypt the servers private key and use it |
| 101 |
for authentication. |
| 102 |
This key file should be read only by the |
| 103 |
.I lpd |
| 104 |
server. |
| 105 |
.SH "User Certificates" |
| 106 |
.PP |
| 107 |
The certificates used by users are kept in a separate directory |
| 108 |
in the users home directory. |
| 109 |
By convention, |
| 110 |
the private keys for these certificate files are stored in the |
| 111 |
certificate file. |
| 112 |
.PP |
| 113 |
The user certificate file is specified by the |
| 114 |
.B LPR_SSL_FILE |
| 115 |
environment variable, |
| 116 |
otherwise the |
| 117 |
.B "${HOME}/.lpr/client.crt" |
| 118 |
is used. |
| 119 |
The password is taken from the file specified by the |
| 120 |
.B LPR_SSL_PASSWORD |
| 121 |
environment variable, |
| 122 |
otherwise the |
| 123 |
.B "${HOME}/.lpr/client.pwd" |
| 124 |
file is read. |
| 125 |
.PP |
| 126 |
.SH "USING LPRNG_CERTS" |
| 127 |
.PP |
| 128 |
The organization of the SSL certificates used by LPRng is |
| 129 |
similar to that used by other programs such as the |
| 130 |
.B Apache |
| 131 |
.B mod_ssl |
| 132 |
support. |
| 133 |
The |
| 134 |
.B lprng_certs |
| 135 |
program is used to create the directory structure, |
| 136 |
create certificates for the root CA, |
| 137 |
signing, |
| 138 |
user and servers. |
| 139 |
In order to make management simple, |
| 140 |
the following support is provided. |
| 141 |
.SH "lprng_certs init" |
| 142 |
.PP |
| 143 |
This command creates the directories used by the |
| 144 |
lpd |
| 145 |
server. |
| 146 |
It is useful when setting up a new |
| 147 |
.B lpd |
| 148 |
server. |
| 149 |
.SH "lprng_certs newca" |
| 150 |
.PP |
| 151 |
This command creates a self-signed certificate, |
| 152 |
suitable for use as a root CA certificate. |
| 153 |
It also sets up a set of default values for other certificate creation. |
| 154 |
.SH "lprng_certs defaults" |
| 155 |
.PP |
| 156 |
This command is used to modify the set of default values. |
| 157 |
.PP |
| 158 |
The default values are listed and should be self-explanatory, |
| 159 |
except for the value of the |
| 160 |
.B signer |
| 161 |
certificate. |
| 162 |
By default, |
| 163 |
the root CA can be used to sign certificates. |
| 164 |
However, |
| 165 |
a signing certificate can be used as well. |
| 166 |
This allows delegation of signing authority without |
| 167 |
compromising the security of the root CA. |
| 168 |
.SH "lprng_certs gen" |
| 169 |
.PP |
| 170 |
This is used to generate a user, server, or signing certificate. |
| 171 |
.SH "lprng_certs index" |
| 172 |
.PP |
| 173 |
This is used to create the indexes for the signing certificates. |
| 174 |
.SH "lprng_certs verify [cert]" |
| 175 |
.PP |
| 176 |
This checks the certificate file using the Openssl |
| 177 |
.B "openssl verify" |
| 178 |
command. |
| 179 |
.SH "lprng_certs encrypt keyfile" |
| 180 |
.PP |
| 181 |
This removes all key information from the key file, |
| 182 |
reencrypts the key information, |
| 183 |
and the puts the encrypted key information in the file. |
| 184 |
.SH "LPRng OPTIONS" |
| 185 |
.nf |
| 186 |
.ta \w'${HOME}/.lpr/client.crt 'u |
| 187 |
Option Purpose |
| 188 |
ssl_ca_path directory holding the SSL signing certs |
| 189 |
ssl_ca_file file holding the root CA or all SSL signing certs |
| 190 |
ssl_server_cert cert file for the server |
| 191 |
ssl_server_password file containing password for server server |
| 192 |
${HOME}/.lpr/client.crt client certificate file |
| 193 |
${HOME}/.lpr/client.pwd client certificate private key password |
| 194 |
.SH "ENVIRONMENT VARIABLES" |
| 195 |
.nf |
| 196 |
.ta \w'${HOME}/.lpr/client.crt 'u |
| 197 |
LPR_SSL_FILE client certificate file |
| 198 |
LPR_SSL_PASSWORD client certificate private key password |
| 199 |
|
| 200 |
.SH "EXIT STATUS" |
| 201 |
.PP |
| 202 |
The following exit values are returned: |
| 203 |
.TP 15 |
| 204 |
.B "zero (0)" |
| 205 |
Successful completion. |
| 206 |
.TP |
| 207 |
.B "non-zero (!=0)" |
| 208 |
An error occurred. |
| 209 |
.SH "SEE ALSO" |
| 210 |
.LP |
| 211 |
lpd.conf(5), |
| 212 |
lpc(8), |
| 213 |
lpd(8), |
| 214 |
checkpc(8), |
| 215 |
lpr(1), |
| 216 |
lpq(1), |
| 217 |
lprm(1), |
| 218 |
printcap(5), |
| 219 |
lpd.conf(5), |
| 220 |
pr(1), lprng_certs(1), lprng_index_certs(1). |
| 221 |
.SH "AUTHOR" |
| 222 |
Patrick Powell <[email protected]>. |
| 223 |
.SH "HISTORY" |
| 224 |
LPRng is a enhanced printer spooler system |
| 225 |
with functionality similar to the Berkeley LPR software. |
| 226 |
The LPRng developer mailing list is [email protected]; |
| 227 |
subscribe by visiting |
| 228 |
.B https://lists.sourceforge.net/lists/listinfo/lprng-devel |
| 229 |
or sending mail to |
| 230 |
.B [email protected] |
| 231 |
with |
| 232 |
the word |
| 233 |
.I subscribe |
| 234 |
in the body. |
| 235 |
.br |
| 236 |
The software is available via |
| 237 |
.B http://lprng.sourceforge.net |