3 * $Id: pixie.h,v 1.1 1999/12/22 15:58:41 mdw Exp $
5 * Passphrase pixie definitions (Unix-specific)
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.1 1999/12/22 15:58:41 mdw
34 * Passphrase pixie support.
38 #ifndef CATACOMB_PIXIE_H
39 #define CATACOMB_PIXIE_H
45 /*----- Header files ------------------------------------------------------*/
49 #include <sys/socket.h>
52 #ifndef CATACOMB_PASSPHRASE_H
53 # include "passphrase.h"
56 /*----- Protocol definition -----------------------------------------------*
58 * The protocol is simple and text-based. The client connects to the
59 * server's socket and sends `request lines', each of which elicits one or
60 * more `response lines' from the server. Request and response lines contain
61 * whitespace-separated fields, and are terminated by a single linefeed. The
62 * final field on a line may contain whitespace. The first field describes
63 * the type of the line. The type field is not case-sensitive, although
64 * writing them in uppercase is conventional.
69 * Provide (very) brief help with the pixie protocol.
72 * Return a list of passphrases currently stored, together with expiry
76 * Request the passphrase named `tag' from the pixie.
79 * Request a new passphrase, which therefore requires verification.
82 * Flush the passphrase named `tag', or all passphrases, from memory.
85 * Requests that the pixie close down.
87 * Response lines are as follows:
90 * Request completed successfully. If a passphrase was requested, it is
91 * returned by the pixie. This is the final response to a request.
94 * Reports an error. The message given is intended to be
95 * human-readable. This is the final response to a request.
98 * Reports a human-readable informational message. Further responses
102 * Reports a passphrase in response to a LIST request. One ITEM
103 * response is given for each passphrase currently in memory. An OK or
104 * FAIL response follows the last ITEM.
106 * Expiry times in requests may be given in any format acceptable to
107 * `getdate'. Expiry times in responses are returned in ISO format
108 * (YYYY-MM-DD HH:MM:SS ZZZ) and are expressed relative to local time.
111 /*----- Functions provided ------------------------------------------------*/
113 /* --- @pixie_open@ --- *
115 * Arguments: @const char *sock@ = path to pixie socket
117 * Returns: Less than zero if it failed, or file descriptor.
119 * Use: Opens a connection to a passphrase pixie.
122 extern int pixie_open(const char */
*sock*/
);
124 /* --- @pixie_read@ --- *
126 * Arguments: @int fd@ = connection to passphrase pixie
127 * @const char *tag@ = pointer to tag string
128 * @unsigned mode@ = reading mode
129 * @char *buf@ = pointer to destination buffer
130 * @size_t sz@ = size of the buffer
132 * Returns: Zero if all went well, nonzero if the read fails.
134 * Use: Reads a passphrase from the pixie.
137 extern int pixie_read(int /*fd*/, const char */
*tag*/
, unsigned /*mode*/,
138 char */
*buf*/
, size_t /*sz*/);
140 /* --- @pixie_cancel@ --- *
142 * Arguments: @int fd@ = pixie file descriptor
143 * @const char *tag@ = pointer to tag string
147 * Use: Cancels a passphrase if it turns out to be bogus.
150 extern void pixie_cancel(int /*fd*/, const char */
*tag*/
);
152 /* --- @pixie_address@ --- *
154 * Arguments: @const char *sock@ = pointer to socket name
155 * @size_t *psz@ = where to write the address size
157 * Returns: Pointer to filled-in Unix-domain socket address.
159 * Use: Returns a Unix-domain socket address to use to find the
163 extern struct sockaddr_un
*pixie_address(const char */
*sock*/
,
166 /* --- @pixie_fdline@ --- *
168 * Arguments: @int fd@ = file descriptor to read from
169 * @char *buf@ = pointer to buffer
170 * @size_t sz@ = size of buffer
174 * Use: Reads a line from a file descriptor. The read is done one
175 * character at a time. If the entire line won't fit, the end
176 * is truncated. The line is null terminated.
179 extern void pixie_fdline(int /*fd*/, char */
*buf*/
, size_t /*sz*/);
181 /* --- @pixie_getpass@ --- *
183 * Arguments: @const char *prompt@ = pointer to prompt string
184 * @char *buf@ = pointer to buffer
185 * @size_t sz@ = size of buffer
187 * Returns: Zero if it worked OK, nonzero otherwise.
189 * Use: Reads a passphrase from the terminal or some other requested
193 extern int pixie_getpass(const char */
*prompt*/
,
194 char */
*buf*/
, size_t /*sz*/);
196 /*----- That's all, folks -------------------------------------------------*/