Documented binary secrets in ipsec.secrets(5) man page.

This commit is contained in:
Tobias Brunner
2011-12-14 17:46:27 +01:00
parent 3eff54a5ca
commit 6d4c6b8f41
+14 -9
View File
@@ -1,4 +1,4 @@
.TH IPSEC.SECRETS 5 "2010-05-30" "@IPSEC_VERSION@" "strongSwan" .TH IPSEC.SECRETS 5 "2011-12-14" "@IPSEC_VERSION@" "strongSwan"
.SH NAME .SH NAME
ipsec.secrets \- secrets for IKE/IPsec authentication ipsec.secrets \- secrets for IKE/IPsec authentication
.SH DESCRIPTION .SH DESCRIPTION
@@ -124,12 +124,17 @@ whitespace).
.SS TYPES OF SECRETS .SS TYPES OF SECRETS
.TP .TP
.B [ <selectors> ] : PSK <secret> .B [ <selectors> ] : PSK <secret>
A preshared secret is most conveniently represented as a sequence of A preshared \fIsecret\fP is most conveniently represented as a sequence of
characters, delimited by double-quote characters (\fB"\fP). characters, which is delimited by double-quote characters (\fB"\fP).
The sequence cannot contain a newline or double-quote. The sequence cannot contain newline or double-quote characters.
Strictly speaking, the secret is actually the sequence .br
of bytes that is used in the file to represent the sequence of Alternatively, preshared secrets can be represented as hexadecimal or Base64
characters (excluding the delimiters). encoded binary values. A character sequence beginning with
.B 0x
is interpreted as sequence of hexadecimal digits.
Similarly, a character sequence beginning with
.B 0s
is interpreted as Base64 encoded binary data.
.TP .TP
.B [ <selectors> ] : RSA <private key file> [ <passphrase> | %prompt ] .B [ <selectors> ] : RSA <private key file> [ <passphrase> | %prompt ]
.TQ .TQ
@@ -142,12 +147,12 @@ can be used which then causes the daemons to ask the user for the password
whenever it is required to decrypt the key. whenever it is required to decrypt the key.
.TP .TP
.B <user id> : EAP <secret> .B <user id> : EAP <secret>
As with \fBPSK\fP secrets the \fIsecret\fP is a sequence of characters, The format of \fIsecret\fP is the same as that of \fBPSK\fP secrets.
delimited by double-quote characters (\fB"\fP).
.br .br
\fBEAP\fP secrets are IKEv2 only. \fBEAP\fP secrets are IKEv2 only.
.TP .TP
.B [ <servername> ] <username> : XAUTH <password> .B [ <servername> ] <username> : XAUTH <password>
The format of \fIpassword\fP is the same as that of \fBPSK\fP secrets.
\fBXAUTH\fP secrets are IKEv1 only. \fBXAUTH\fP secrets are IKEv1 only.
.TP .TP
.B : PIN <smartcard selector> <pin code> | %prompt .B : PIN <smartcard selector> <pin code> | %prompt