Added documentation for NTLM secrets
[strongswan.git] / man / ipsec.secrets.5.in
1 .TH IPSEC.SECRETS 5 "2011-12-14" "@IPSEC_VERSION@" "strongSwan"
2 .SH NAME
3 ipsec.secrets \- secrets for IKE/IPsec authentication
4 .SH DESCRIPTION
5 The file \fIipsec.secrets\fP holds a table of secrets.
6 These secrets are used by the strongSwan Internet Key Exchange (IKE) daemons
7 pluto (IKEv1) and charon (IKEv2) to authenticate other hosts.
8 .LP
9 It is vital that these secrets be protected.  The file should be owned
10 by the super-user,
11 and its permissions should be set to block all access by others.
12 .LP
13 The file is a sequence of entries and include directives.
14 Here is an example.
15 .LP
16 .RS
17 .nf
18 # /etc/ipsec.secrets - strongSwan IPsec secrets file
19 192.168.0.1 %any : PSK "v+NkxY9LLZvwj4qCC2o/gGrWDF2d21jL"
20
21 : RSA moonKey.pem
22
23 alice@strongswan.org : EAP "x3.dEhgN"
24
25 carol : XAUTH "4iChxLT3"
26
27 dave  : XAUTH "ryftzG4A"
28
29 # get secrets from other files
30 include ipsec.*.secrets
31 .fi
32 .RE
33 .LP
34 Each entry in the file is a list of optional ID selectors, followed by a secret.
35 The two parts are separated by a colon (\fB:\fP) that is surrounded
36 by whitespace. If no ID selectors are specified the line must start with a
37 colon.
38 .LP
39 A selector is an IP address, a Fully Qualified Domain Name, user@FQDN,
40 \fB%any\fP or \fB%any6\fP (other kinds may come).  An IP address may be written
41 in the familiar dotted quad form or as a domain name to be looked up
42 when the file is loaded.
43 In many cases it is a bad idea to use domain names because
44 the name server may not be running or may be insecure.  To denote a
45 Fully Qualified Domain Name (as opposed to an IP address denoted by
46 its domain name), precede the name with an at sign (\fB@\fP).
47 .LP
48 Matching IDs with selectors is fairly straightforward: they have to be
49 equal.  In the case of a ``Road Warrior'' connection, if an equal
50 match is not found for the Peer's ID, and it is in the form of an IP
51 address, a selector of \fB%any\fP will match the peer's IP address if IPV4
52 and \fB%any6\fP will match a the peer's IP address if IPV6.
53 Currently, the obsolete notation \fB0.0.0.0\fP may be used in place of
54 \fB%any\fP.
55 .LP
56 In IKEv1 an additional complexity
57 arises in the case of authentication by preshared secret: the
58 responder will need to look up the secret before the Peer's ID payload has
59 been decoded, so the ID used will be the IP address.
60 .LP
61 To authenticate a connection between two hosts, the entry that most
62 specifically matches the host and peer IDs is used.  An entry with no
63 selectors will match any host and peer.  More specifically, an entry with one
64 selector will match a host and peer if the selector matches the host's ID (the
65 peer isn't considered).  Still more specifically, an entry with multiple
66 selectors will match a host and peer if the host ID and peer ID each match one
67 of the selectors.  If the key is for an asymmetric authentication technique
68 (i.e. a public key system such as RSA), an entry with multiple selectors will
69 match a host and peer even if only the host ID matches a selector (it is
70 presumed that the selectors are all identities of the host).
71 It is acceptable for two entries to be the best match as
72 long as they agree about the secret or private key.
73 .LP
74 Authentication by preshared secret requires that both systems find the
75 identical secret (the secret is not actually transmitted by the IKE
76 protocol).  If both the host and peer appear in the selector list, the
77 same entry will be suitable for both systems so verbatim copying
78 between systems can be used.  This naturally extends to larger groups
79 sharing the same secret.  Thus multiple-selector entries are best for PSK
80 authentication.
81 .LP
82 Authentication by public key systems such as RSA requires that each host
83 have its own private key.  A host could reasonably use a different private keys
84 for different interfaces and for different peers.  But it would not
85 be normal to share entries between systems.  Thus thus no-selector and
86 one-selector forms of entry often make sense for public key authentication.
87 .LP
88 The key part of an entry must start with a token indicating the kind of
89 key.  The following types of secrets are currently supported:
90 .TP
91 .B PSK
92 defines a pre-shared key
93 .TP
94 .B RSA
95 defines an RSA private key
96 .TP
97 .B ECDSA
98 defines an ECDSA private key
99 .TP
100 .B EAP
101 defines EAP credentials
102 .TP
103 .B NTLM
104 defines NTLM credentials
105 .TP
106 .B XAUTH
107 defines XAUTH credentials
108 .TP
109 .B PIN
110 defines a smartcard PIN
111 .LP
112 Details on each type of secret are given below.
113 .LP
114 Whitespace at the end of a line is ignored. At the start of a line or
115 after whitespace, \fB#\fP and the following text up to the end of the
116 line is treated as a comment.
117 .LP
118 An include directive causes the contents of the named file to be processed
119 before continuing with the current file.  The filename is subject to
120 ``globbing'' as in \fIsh\fP(1), so every file with a matching name
121 is processed.  Includes may be nested to a modest
122 depth (10, currently).  If the filename doesn't start with a \fB/\fP, the
123 directory containing the current file is prepended to the name.  The
124 include directive is a line that starts with the word \fBinclude\fP,
125 followed by whitespace, followed by the filename (which must not contain
126 whitespace).
127 .SS TYPES OF SECRETS
128 .TP
129 .B [ <selectors> ] : PSK <secret>
130 A preshared \fIsecret\fP is most conveniently represented as a sequence of
131 characters, which is delimited by double-quote characters (\fB"\fP).
132 The sequence cannot contain newline or double-quote characters.
133 .br
134 Alternatively, preshared secrets can be represented as hexadecimal or Base64
135 encoded binary values. A character sequence beginning with
136 .B 0x
137 is interpreted as sequence of hexadecimal digits.
138 Similarly, a character sequence beginning with
139 .B 0s
140 is interpreted as Base64 encoded binary data.
141 .TP
142 .B [ <selectors> ] : RSA <private key file> [ <passphrase> | %prompt ]
143 .TQ
144 .B [ <selectors> ] : ECDSA <private key file> [ <passphrase> | %prompt ]
145 For the private key file both absolute paths or paths relative to
146 \fI/etc/ipsec.d/private\fP are accepted. If the private key file is
147 encrypted, the \fIpassphrase\fP must be defined. Instead of a passphrase
148 .B %prompt
149 can be used which then causes the daemons to ask the user for the password
150 whenever it is required to decrypt the key.
151 .TP
152 .B <user id> : EAP <secret>
153 The format of \fIsecret\fP is the same as that of \fBPSK\fP secrets.
154 .br
155 \fBEAP\fP secrets are IKEv2 only.
156 .TP
157 .B <user id> : NTLM <secret>
158 The format of \fIsecret\fP is the same as that of \fBPSK\fP secrets, but the
159 secret is stored as NTLM hash, which is MD4(UTF-16LE(secret)), instead of as
160 cleartext.
161 .br
162 \fBNTLM\fP secrets can only be used with the \fBeap-mschapv2\fP plugin.
163 .TP
164 .B [ <servername> ] <username> : XAUTH <password>
165 The format of \fIpassword\fP is the same as that of \fBPSK\fP secrets.
166 \fBXAUTH\fP secrets are IKEv1 only.
167 .TP
168 .B : PIN %smartcard[<slot nr>[@<module>]]:<keyid> <pin code> | %prompt
169 The smartcard selector always requires a keyid to uniquely select the correct
170 key. The slot number defines the slot on the token, the module name refers to
171 the module name defined in strongswan.conf(5).
172 Instead of specifying the pin code statically,
173 .B %prompt
174 can be specified, which causes the daemons to ask the user for the pin code.
175 .LP
176
177 .SH FILES
178 /etc/ipsec.secrets
179 .SH SEE ALSO
180 ipsec.conf(5), strongswan.conf(5), ipsec(8)
181 .br
182 .SH HISTORY
183 Originally written for the FreeS/WAN project by D. Hugh Redelmeier.
184 Updated and extended for the strongSwan project <http://www.strongswan.org> by
185 Tobias Brunner and Andreas Steffen.
186 .SH BUGS
187 If an ID is \fB0.0.0.0\fP, it will match \fB%any\fP;
188 if it is \fB0::0\fP, it will match \fB%any6\fP.