5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2001 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
21 /****h* silccore/SilcAuthAPI
25 * Implementations of the SILC Authentication Payload and authentication
26 * routines. The SILC Authentication Payload is used to deliver
27 * authentication data usually from client to server in purpose of
28 * gaining access to some service. The Payload and the authentication
29 * routines supports both passphrase and public key (signature) based
32 * This interface defines also the SILC Key Agreement Payload that is
33 * used by client to agree on key material usually with another client
41 /****s* silccore/SilcAuthAPI/SilcAuthPayload
45 * typedef struct SilcAuthPayloadStruct *SilcAuthPayload;
50 * This context is the actual Authentication Payload and is allocated
51 * by silc_auth_payload_parse and given as argument usually to all
52 * silc_auth_payload_* functions. It is freed by silc_auth_payload_free
56 typedef struct SilcAuthPayloadStruct *SilcAuthPayload;
58 /****s* silccore/SilcAuthAPI/SilcKeyAgreementPayload
62 * typedef struct SilcKeyAgreementPayloadStruct *SilcKeyAgreementPayload;
66 * This context is the actual Key Agreement Payload and is allocated
67 * by silc_key_agreement_payload_parse and given as argument usually to all
68 * silc_key_agreement_* functions. It is freed by the function
69 * silc_key_agreement_payload_free.
72 typedef struct SilcKeyAgreementPayloadStruct *SilcKeyAgreementPayload;
74 /****d* silccore/SilcAuthAPI/SilcAuthMethod
78 * typedef SilcUInt16 SilcAuthMethod;
82 * Authentication method type definition, the authentication methods
83 * and the authentication status'. The status defines are used by
84 * all authentication protocols in the SILC.
88 typedef SilcUInt16 SilcAuthMethod;
90 #define SILC_AUTH_NONE 0 /* No authentication */
91 #define SILC_AUTH_PASSWORD 1 /* Passphrase authentication */
92 #define SILC_AUTH_PUBLIC_KEY 2 /* Public key authentication */
94 /* Authentication protocol status message (used by all authentication
95 protocols in the SILC). */
96 #define SILC_AUTH_OK 0
97 #define SILC_AUTH_FAILED 1
102 /****f* silccore/SilcAuthAPI/silc_auth_payload_parse
106 * SilcAuthPayload silc_auth_payload_parse(const unsigned char *data,
107 * SilcUInt32 data_len);
111 * Parses and returns Authentication Payload. The `data' and the
112 * `data_len' are the raw payload buffer.
115 SilcAuthPayload silc_auth_payload_parse(const unsigned char *data,
116 SilcUInt32 data_len);
118 /****f* silccore/SilcAuthAPI/silc_auth_payload_encode
122 * SilcBuffer silc_auth_payload_encode(SilcAuthMethod method,
123 * const unsigned char *random_data,
124 * SilcUInt16 random_len,
125 * const unsigned char *auth_data,
126 * SilcUInt16 auth_len);
130 * Encodes authentication payload into buffer and returns it.
131 * The `random_data' is provided only if doing public key authentication.
132 * The `auth_data' is the actual authentication data.
135 SilcBuffer silc_auth_payload_encode(SilcAuthMethod method,
136 const unsigned char *random_data,
137 SilcUInt16 random_len,
138 const unsigned char *auth_data,
139 SilcUInt16 auth_len);
141 /****f* silccore/SilcAuthAPI/silc_auth_payload_free
145 * void silc_auth_payload_free(SilcAuthPayload payload);
149 * Frees authentication payload and all data in it.
152 void silc_auth_payload_free(SilcAuthPayload payload);
154 /****f* silccore/SilcAuthAPI/silc_auth_get_method
158 * SilcAuthMethod silc_auth_get_method(SilcAuthPayload payload);
162 * Get authentication method.
165 SilcAuthMethod silc_auth_get_method(SilcAuthPayload payload);
167 /****f* silccore/SilcAuthAPI/silc_auth_get_data
171 * unsigned char *silc_auth_get_data(SilcAuthPayload payload,
172 * SilcUInt32 *auth_len);
176 * Get the authentication data. The caller must not free the data.
179 unsigned char *silc_auth_get_data(SilcAuthPayload payload,
180 SilcUInt32 *auth_len);
182 /****f* silccore/SilcAuthAPI/silc_auth_public_key_auth_generate
186 * SilcBuffer silc_auth_public_key_auth_generate(SilcPublicKey public_key,
187 * SilcPrivateKey private_key,
194 * Generates Authentication Payload with authentication data. This is used
195 * to do public key based authentication. This generates the random data
196 * and the actual authentication data. Returns NULL on error and the
197 * encoded Authentication Payload on success.
200 SilcBuffer silc_auth_public_key_auth_generate(SilcPublicKey public_key,
201 SilcPrivateKey private_key,
203 const void *id, SilcIdType type);
205 /****f* silccore/SilcAuthAPI/silc_auth_public_key_auth_verify
209 * bool silc_auth_public_key_auth_verify(SilcAuthPayload payload,
210 * SilcPublicKey public_key,
212 * const void *id, SilcIdType type);
216 * Verifies the authentication data. Returns TRUE if authentication was
220 bool silc_auth_public_key_auth_verify(SilcAuthPayload payload,
221 SilcPublicKey public_key, SilcHash hash,
222 const void *id, SilcIdType type);
224 /****f* silccore/SilcAuthAPI/silc_auth_public_key_auth_verify_data
228 * bool silc_auth_public_key_auth_verify_data(const unsigned char *payload,
229 * SilcUInt32 payload_len,
230 * SilcPublicKey public_key,
237 * Same as silc_auth_public_key_auth_verify but the payload has not
238 * been parsed yet. This will parse it. Returns TRUE if authentication
242 bool silc_auth_public_key_auth_verify_data(const unsigned char *payload,
243 SilcUInt32 payload_len,
244 SilcPublicKey public_key,
246 const void *id, SilcIdType type);
248 /****f* silccore/SilcAuthAPI/silc_auth_verify
252 * bool silc_auth_verify(SilcAuthPayload payload,
253 * SilcAuthMethod auth_method,
254 * const void *auth_data, SilcUInt32 auth_data_len,
255 * SilcHash hash, const void *id, SilcIdType type);
259 * Verifies the authentication data directly from the Authentication
260 * Payload. Supports all authentication methods. If the authentication
261 * method is passphrase based then the `auth_data' and `auth_data_len'
262 * are the passphrase and its length. If the method is public key
263 * authentication then the `auth_data' is the SilcPublicKey and the
264 * `auth_data_len' is ignored.
267 bool silc_auth_verify(SilcAuthPayload payload, SilcAuthMethod auth_method,
268 const void *auth_data, SilcUInt32 auth_data_len,
269 SilcHash hash, const void *id, SilcIdType type);
271 /****f* silccore/SilcAuthAPI/silc_auth_verify_data
275 * bool silc_auth_verify_data(const unsigned char *payload,
276 * SilcUInt32 payload_len,
277 * SilcAuthMethod auth_method,
278 * const void *auth_data,
279 * SilcUInt32 auth_data_len, SilcHash hash,
280 * const void *id, SilcIdType type);
284 * Same as silc_auth_verify but the payload has not been parsed yet.
285 * Verifies the authentication data directly from the Authentication
286 * Payload. Supports all authentication methods. If the authentication
287 * method is passphrase based then the `auth_data' and `auth_data_len'
288 * are the passphrase and its length. If the method is public key
289 * authentication then the `auth_data' is the SilcPublicKey and the
290 * `auth_data_len' is ignored.
293 bool silc_auth_verify_data(const unsigned char *payload, SilcUInt32 payload_len,
294 SilcAuthMethod auth_method, const void *auth_data,
295 SilcUInt32 auth_data_len, SilcHash hash,
296 const void *id, SilcIdType type);
298 /****f* silccore/SilcAuthAPI/silc_key_agreement_payload_parse
302 * SilcKeyAgreementPayload
303 * silc_key_agreement_payload_parse(const unsigned char *payload,
304 * SilcUInt32 payload_len);
308 * Parses and returns an allocated Key Agreement payload.
311 SilcKeyAgreementPayload
312 silc_key_agreement_payload_parse(const unsigned char *payload,
313 SilcUInt32 payload_len);
315 /****f* silccore/SilcAuthAPI/silc_key_agreement_payload_encode
319 * SilcBuffer silc_key_agreement_payload_encode(char *hostname,
324 * Encodes the Key Agreement protocol and returns the encoded buffer
327 SilcBuffer silc_key_agreement_payload_encode(const char *hostname,
330 /****f* silccore/SilcAuthAPI/silc_key_agreement_payload_free
334 * void silc_key_agreement_payload_free(SilcKeyAgreementPayload payload);
338 * Frees the Key Agreement protocol and all data in it.
341 void silc_key_agreement_payload_free(SilcKeyAgreementPayload payload);
343 /****f* silccore/SilcAuthAPI/silc_key_agreement_get_hostname
347 * char *silc_key_agreement_get_hostname(SilcKeyAgreementPayload payload);
351 * Returns the hostname in the payload. Caller must not free it.
352 * The hostname is the host that is able to accept key negotiation
353 * using the SILC Key Exchange protocol.
356 char *silc_key_agreement_get_hostname(SilcKeyAgreementPayload payload);
358 /****f* silccore/SilcAuthAPI/silc_key_agreement_get_port
362 * SilcUInt32 silc_key_agreement_get_port(SilcKeyAgreementPayload payload);
366 * Returns the port in the payload. The port is the port on the
367 * host returned by silc_key_agreement_get_hostname that is running
368 * the SILC Key Exchange protocol.
371 SilcUInt32 silc_key_agreement_get_port(SilcKeyAgreementPayload payload);