[u/mdw/catacomb] / keyring.5

.\" -*-nroff-*-
.TH keyring 5 "5 June 1999" Catacomb
.SH NAME
keyring \- description of Catacomb keyring files
.SH DESCRIPTION
Keyring files are line-oriented text files.  It is recommended that
programs use only the provided interface for reading and modifying
keyring files for consistency of locking and representation: this
description is provided for the benefit of administrators attempting to
understand or repair keyring files.
.PP
Lines containing only whitespace and lines whose first non-whitespace
character is
.RB ` # '
are ignored, but are not written back to the file.  Thus, the comment
facility is not particularly useful.
.PP
Each remaining line describes a key.  Key descriptions consist of
between 4 and six whitespace-separated fields.  The final comment field
may contain whitespace characters.  The fields are, in order:
.TP
.B type
The key's type string, set when the key was created.
.TP
.B "key data"
The actual key, Base64 encoded, as described in RFC2045.
.TP
.B "expiry time"
The time at which this key expires, represented as an integer, in the
format returned by the
.BR time (2)
system call.
.TP
.B "deletion time"
The time at which this key should be deleted, using the same
representation as the expiry time.  The special value 0 signifies that
the key should be deleted on expiry.
.TP
.B attributes
The key's attributes, encoded using the `form-urlencoded' encoding
defined in RFC1866.  This field is optional: if it is omitted, the key
has no attributes.  Alternatively, if there are no attributes, this
field may be given as a single dash
.RB ` \- '.
.TP
.B comment
The comment field.  This field is optional.  It may contain whitespace.
It is deliberately not included as an attribute, since the urlencoded
nature of attributes makes them hard to read when perusing a keyring
file.
.PP
It is not envisaged that the file format will change in the future.  Any
extensions will be made by defining new attributes.
.SH AUTHOR
Mark Wooding, <mdw@nsict.org>
Commit	Line	Data
d03ab969	1	.\" --nroff--
	2	.TH keyring 5 "5 June 1999" Catacomb
	3	.SH NAME
	4	keyring \- description of Catacomb keyring files
	5	.SH DESCRIPTION
	6	Keyring files are line-oriented text files. It is recommended that
	7	programs use only the provided interface for reading and modifying
2d3bea94	8	keyring files for consistency of locking and representation: this
d03ab969	9	description is provided for the benefit of administrators attempting to
	10	understand or repair keyring files.
	11	.PP
	12	Lines containing only whitespace and lines whose first non-whitespace
	13	character is
	14	.RB ` # '
	15	are ignored, but are not written back to the file. Thus, the comment
	16	facility is not particularly useful.
	17	.PP
2d3bea94	18	Each remaining line describes a key. Key descriptions consist of
	19	between 4 and six whitespace-separated fields. The final comment field
	20	may contain whitespace characters. The fields are, in order:
d03ab969	21	.TP
	22	.B type
	23	The key's type string, set when the key was created.
	24	.TP
	25	.B "key data"
	26	The actual key, Base64 encoded, as described in RFC2045.
	27	.TP
	28	.B "expiry time"
c9e31e42	29	The time at which this key expires, represented as an integer, in the
	30	format returned by the
	31	.BR time (2)
	32	system call.
d03ab969	33	.TP
	34	.B "deletion time"
	35	The time at which this key should be deleted, using the same
	36	representation as the expiry time. The special value 0 signifies that
	37	the key should be deleted on expiry.
	38	.TP
	39	.B attributes
	40	The key's attributes, encoded using the `form-urlencoded' encoding
	41	defined in RFC1866. This field is optional: if it is omitted, the key
	42	has no attributes. Alternatively, if there are no attributes, this
	43	field may be given as a single dash
	44	.RB ` \- '.
	45	.TP
	46	.B comment
	47	The comment field. This field is optional. It may contain whitespace.
	48	It is deliberately not included as an attribute, since the urlencoded
	49	nature of attributes makes them hard to read when perusing a keyring
	50	file.
	51	.PP
	52	It is not envisaged that the file format will change in the future. Any
	53	extensions will be made by defining new attributes.
	54	.SH AUTHOR
	55	Mark Wooding, <mdw@nsict.org>