5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 2000 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.
24 #include "silcske_status.h"
26 /* Forward declaration for SKE object. */
27 typedef struct SilcSKEStruct *SilcSKE;
29 /* Forward declaration for security properties. */
30 typedef struct SilcSKESecurityPropertiesStruct *SilcSKESecurityProperties;
32 /* Supported Public Key Types, defined by the protocol */
34 SILC_SKE_PK_TYPE_SILC = 1, /* Mandatory type */
35 /* Optional types. These are not implemented currently
36 SILC_SKE_PK_TYPE_SSH2 = 2,
37 SILC_SKE_PK_TYPE_X509V3 = 3,
38 SILC_SKE_PK_TYPE_OPENPGP = 4,
39 SILC_SKE_PK_TYPE_SPKI = 5
43 /* Packet sending callback. Caller of the SKE routines must provide
44 a routine to send packets to negotiation parties. */
45 typedef void (*SilcSKESendPacketCb)(SilcSKE ske, SilcBuffer packet,
46 SilcPacketType type, void *context);
48 /* Generic SKE callback function. This is called in various SKE
49 routines. The SilcSKE object sent as argument provides all the data
50 callers routine might need (payloads etc). */
51 typedef void (*SilcSKECb)(SilcSKE ske, void *context);
53 /* Callback function used to verify the received public key. */
54 typedef SilcSKEStatus (*SilcSKEVerifyCb)(SilcSKE ske,
55 unsigned char *pk_data,
57 SilcSKEPKType pk_type,
60 /* Context passed to key material processing function. The function
61 returns the processed key material into this structure. */
63 unsigned char *send_iv;
64 unsigned char *receive_iv;
66 unsigned char *send_enc_key;
67 unsigned char *receive_enc_key;
68 unsigned int enc_key_len;
69 unsigned char *hmac_key;
70 unsigned int hmac_key_len;
73 /* Length of cookie in Start Payload */
74 #define SILC_SKE_COOKIE_LEN 16
79 /* Security Property Flags. */
81 SILC_SKE_SP_FLAG_NONE = (1L << 0),
82 SILC_SKE_SP_FLAG_NO_REPLY = (1L << 1),
83 SILC_SKE_SP_FLAG_PFS = (1L << 2),
84 } SilcSKESecurityPropertyFlag;
86 /* Security Properties negotiated between key exchange parties. This
87 structure is filled from the Key Exchange Start Payload which is used
88 to negotiate what security properties should be used in the
90 struct SilcSKESecurityPropertiesStruct {
92 SilcSKEDiffieHellmanGroup group;
96 /* XXX SilcCompression comp; */
99 struct SilcSKEStruct {
100 /* The connection object. This is initialized by the caller. */
101 SilcSocketConnection sock;
103 /* Security properties negotiated */
104 SilcSKESecurityProperties prop;
106 /* Key Exchange payloads filled during key negotiation with
107 remote data. Responder may save local data here as well. */
108 SilcSKEStartPayload *start_payload;
109 SilcSKEOnePayload *ke1_payload;
110 SilcSKETwoPayload *ke2_payload;
112 /* Temporary copy of the KE Start Payload used in the
114 SilcBuffer start_payload_copy;
116 /* If initiator, this is responders public key. If responder this
117 is our own public key. */
121 /* Random number x, 1 < x < q. This is the secret exponent
122 used in Diffie Hellman computations. */
125 /* The secret shared key */
128 /* The hash value HASH of the key exchange */
130 unsigned int hash_len;
132 /* Random Number Generator. This is set by the caller and must
133 be free'd by the caller. */
136 /* Pointer to the what ever user data. This is set by the caller
137 and is not touched by the SKE. The caller must also free this one. */
142 SilcSKE silc_ske_alloc();
143 void silc_ske_free(SilcSKE ske);
144 SilcSKEStatus silc_ske_initiator_start(SilcSKE ske, SilcRng rng,
145 SilcSocketConnection sock,
146 SilcSKEStartPayload *start_payload,
147 SilcSKESendPacketCb send_packet,
149 SilcSKEStatus silc_ske_initiator_phase_1(SilcSKE ske,
150 SilcBuffer start_payload,
153 SilcSKEStatus silc_ske_initiator_phase_2(SilcSKE ske,
154 SilcPublicKey public_key,
155 SilcSKESendPacketCb send_packet,
157 SilcSKEStatus silc_ske_initiator_finish(SilcSKE ske,
158 SilcBuffer ke2_payload,
159 SilcSKEVerifyCb verify_key,
160 void *verify_context,
163 SilcSKEStatus silc_ske_responder_start(SilcSKE ske, SilcRng rng,
164 SilcSocketConnection sock,
166 SilcBuffer start_payload,
169 SilcSKEStatus silc_ske_responder_phase_1(SilcSKE ske,
170 SilcSKEStartPayload *start_payload,
171 SilcSKESendPacketCb send_packet,
173 SilcSKEStatus silc_ske_responder_phase_2(SilcSKE ske,
174 SilcBuffer ke1_payload,
177 SilcSKEStatus silc_ske_responder_finish(SilcSKE ske,
178 SilcPublicKey public_key,
179 SilcPrivateKey private_key,
180 SilcSKEPKType pk_type,
181 SilcSKESendPacketCb send_packet,
183 SilcSKEStatus silc_ske_end(SilcSKE ske,
184 SilcSKESendPacketCb send_packet,
186 SilcSKEStatus silc_ske_abort(SilcSKE ske, SilcSKEStatus status,
187 SilcSKESendPacketCb send_packet,
190 silc_ske_assemble_security_properties(SilcSKE ske,
193 SilcSKEStartPayload **return_payload);
195 silc_ske_select_security_properties(SilcSKE ske,
197 SilcSKEStartPayload *payload,
198 SilcSKEStartPayload *remote_payload);
199 SilcSKEStatus silc_ske_create_rnd(SilcSKE ske, SilcInt n,
202 SilcSKEStatus silc_ske_make_hash(SilcSKE ske,
203 unsigned char *return_hash,
204 unsigned int *return_hash_len);
205 SilcSKEStatus silc_ske_process_key_material(SilcSKE ske,
206 unsigned int req_iv_len,
207 unsigned int req_enc_key_len,
208 unsigned int req_hmac_key_len,
209 SilcSKEKeyMaterial *key);