Initial code commit for Toolkit 1.1.

[silc.git] / lib / silcske / silcske.h

diff --git a/lib/silcske/silcske.h b/lib/silcske/silcske.h
index 88771956ab3d8311bf8e2142f099c098ed2af41f..554da9e71bc7cf66cd2dd688ada5a8b779c48cd9 100644 (file)
--- a/lib/silcske/silcske.h
+++ b/lib/silcske/silcske.h
@@ -20,7 +20,7 @@
 #ifndef SILCSKE_H
 #define SILCSKE_H
 
-/****h* silcske/SilcSKEAPI
+/****h* silcske/SILC SKE Interface
  *
  * DESCRIPTION
  *
@@ -183,7 +183,7 @@ typedef void (*SilcSKEVerifyCbCompletion)(SilcSKE ske,
  *
  *    typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
  *                                    unsigned char *pk_data,
- *                                    uint32 pk_len,
+ *                                    SilcUInt32 pk_len,
  *                                    SilcSKEPKType pk_type,
  *                                    void *context,
  *                                    SilcSKEVerifyCbCompletion completion,
@@ -202,7 +202,7 @@ typedef void (*SilcSKEVerifyCbCompletion)(SilcSKE ske,
  ***/
 typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
                                unsigned char *pk_data,
-                               uint32 pk_len,
+                               SilcUInt32 pk_len,
                                SilcSKEPKType pk_type,
                                void *context,
                                SilcSKEVerifyCbCompletion completion,
@@ -214,7 +214,7 @@ typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
  *
  *    typedef SilcSKEStatus (*SilcSKECheckVersion)(SilcSKE ske,
  *                                                 unsigned char *version,
- *                                                 uint32 len, void *context);
+ *                                                 SilcUInt32 len, void *context);
  *
  * DESCRIPTION
  *
@@ -227,7 +227,7 @@ typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
  ***/
 typedef SilcSKEStatus (*SilcSKECheckVersion)(SilcSKE ske,
                                             unsigned char *version,
-                                            uint32 len, void *context);
+                                            SilcUInt32 len, void *context);
 
 /****s* silcske/SilcSKEAPI/SilcSKEKeyMaterial
  *
@@ -245,13 +245,13 @@ typedef SilcSKEStatus (*SilcSKECheckVersion)(SilcSKE ske,
 typedef struct {
   unsigned char *send_iv;
   unsigned char *receive_iv;
-  uint32 iv_len;
+  SilcUInt32 iv_len;
   unsigned char *send_enc_key;
   unsigned char *receive_enc_key;
-  uint32 enc_key_len;
+  SilcUInt32 enc_key_len;
   unsigned char *send_hmac_key;
   unsigned char *receive_hmac_key;
-  uint32 hmac_key_len;
+  SilcUInt32 hmac_key_len;
 } SilcSKEKeyMaterial;
 
 /* Length of cookie in Start Payload */
@@ -273,10 +273,10 @@ typedef struct {
  * SOURCE
  */
 typedef enum {
-  SILC_SKE_SP_FLAG_NONE      = 0x00,     /* No flags */
-  SILC_SKE_SP_FLAG_NO_REPLY  = 0x01,    /* No reply required to payload */
-  SILC_SKE_SP_FLAG_PFS       = 0x02,    /* Perfect Forward Secrecy */
-  SILC_SKE_SP_FLAG_MUTUAL    = 0x04,    /* Mutual authentication */
+  SILC_SKE_SP_FLAG_NONE         = 0x00,         /* No flags */
+  SILC_SKE_SP_FLAG_IV_INCLUDED  = 0x01,         /* IV included in ciphertexts */
+  SILC_SKE_SP_FLAG_PFS          = 0x02,         /* Perfect Forward Secrecy */
+  SILC_SKE_SP_FLAG_MUTUAL       = 0x04,         /* Mutual authentication */
 } SilcSKESecurityPropertyFlag;
 /***/
 
@@ -325,7 +325,9 @@ struct SilcSKESecurityPropertiesStruct {
  */
 struct SilcSKEStruct {
   /* The connection object. This is initialized by the caller. */
+#if 0
   SilcSocketConnection sock;
+#endif
 
   /* Security properties negotiated */
   SilcSKESecurityProperties prop;
@@ -335,6 +337,7 @@ struct SilcSKEStruct {
   SilcSKEStartPayload *start_payload;
   SilcSKEKEPayload *ke1_payload;
   SilcSKEKEPayload *ke2_payload;
+  unsigned char *remote_version;
 
   /* Temporary copy of the KE Start Payload used in the
      HASH computation. */
@@ -349,7 +352,7 @@ struct SilcSKEStruct {
 
   /* The hash value HASH of the key exchange */
   unsigned char *hash;
-  uint32 hash_len;
+  SilcUInt32 hash_len;
 
   /* Random Number Generator. This is set by the caller and must
      be free'd by the caller. */
@@ -370,7 +373,7 @@ struct SilcSKEStruct {
   SilcSKECallbacks callbacks;
 
   /* Backwards support version indicator */
-  uint32 backward_version;
+  SilcUInt32 backward_version;
 };
 /***/
 
@@ -500,7 +503,9 @@ void silc_ske_set_callbacks(SilcSKE ske,
  *
  ***/
 SilcSKEStatus silc_ske_initiator_start(SilcSKE ske, SilcRng rng,
+#if 0
                                       SilcSocketConnection sock,
+#endif
                                       SilcSKEStartPayload *start_payload);
 
 /****f* silcske/SilcSKEAPI/silc_ske_initiator_phase_1
@@ -624,7 +629,9 @@ SilcSKEStatus silc_ske_initiator_finish(SilcSKE ske,
  *
  ***/
 SilcSKEStatus silc_ske_responder_start(SilcSKE ske, SilcRng rng,
+#if 0
                                       SilcSocketConnection sock,
+#endif
                                       const char *version,
                                       SilcBuffer start_payload,
                                       SilcSKESecurityPropertyFlag flags);
@@ -820,9 +827,9 @@ silc_ske_select_security_properties(SilcSKE ske,
  * SYNOPSIS
  *
  *    SilcSKEStatus silc_ske_process_key_material(SilcSKE ske,
- *                                                uint32 req_iv_len,
- *                                                uint32 req_enc_key_len,
- *                                                uint32 req_hmac_key_len,
+ *                                                SilcUInt32 req_iv_len,
+ *                                                SilcUInt32 req_enc_key_len,
+ *                                                SilcUInt32 req_hmac_key_len,
  *                                                SilcSKEKeyMaterial *key);
  *
  * DESCRIPTION
@@ -840,9 +847,9 @@ silc_ske_select_security_properties(SilcSKE ske,
  *
  ***/
 SilcSKEStatus silc_ske_process_key_material(SilcSKE ske,
-                                           uint32 req_iv_len,
-                                           uint32 req_enc_key_len,
-                                           uint32 req_hmac_key_len,
+                                           SilcUInt32 req_iv_len,
+                                           SilcUInt32 req_enc_key_len,
+                                           SilcUInt32 req_hmac_key_len,
                                            SilcSKEKeyMaterial *key);
 
 /****f* silcske/SilcSKEAPI/silc_ske_process_key_material_data
@@ -851,10 +858,10 @@ SilcSKEStatus silc_ske_process_key_material(SilcSKE ske,
  *
  *    SilcSKEStatus
  *    silc_ske_process_key_material_data(unsigned char *data,
- *                                       uint32 data_len,
- *                                       uint32 req_iv_len,
- *                                       uint32 req_enc_key_len,
- *                                       uint32 req_hmac_key_len,
+ *                                       SilcUInt32 data_len,
+ *                                       SilcUInt32 req_iv_len,
+ *                                       SilcUInt32 req_enc_key_len,
+ *                                       SilcUInt32 req_hmac_key_len,
  *                                       SilcHash hash,
  *                                       SilcSKEKeyMaterial *key);
  *
@@ -872,10 +879,10 @@ SilcSKEStatus silc_ske_process_key_material(SilcSKE ske,
  ***/
 SilcSKEStatus
 silc_ske_process_key_material_data(unsigned char *data,
-                                  uint32 data_len,
-                                  uint32 req_iv_len,
-                                  uint32 req_enc_key_len,
-                                  uint32 req_hmac_key_len,
+                                  SilcUInt32 data_len,
+                                  SilcUInt32 req_iv_len,
+                                  SilcUInt32 req_enc_key_len,
+                                  SilcUInt32 req_hmac_key_len,
                                   SilcHash hash,
                                   SilcSKEKeyMaterial *key);
 
@@ -892,4 +899,32 @@ silc_ske_process_key_material_data(unsigned char *data,
  ***/
 void silc_ske_free_key_material(SilcSKEKeyMaterial *key);
 
+/****f* silcske/SilcSKEAPI/silc_ske_parse_version
+ *
+ * SYNOPSIS
+ *
+ *    bool silc_ske_parse_version(SilcSKE ske, 
+ *                                SilcUInt32 *protocol_version,
+ *                                char **protocol_version_string,
+ *                                SilcUInt32 *software_version, 
+ *                                char **software_version_string,
+ *                                char **vendor_version);
+ *
+ * DESCRIPTION
+ *
+ *    This utility function can be used to parse the remote host's version
+ *    string.  This returns the protocol version, and software version into
+ *    the `protocol_version', `software_version' and `vendor_version' pointers
+ *    if they are provided.  The string versions of the versions are saved
+ *    in *_string pointers if they are provided.  Returns TRUE if the version
+ *    string was successfully parsed.
+ *
+ ***/
+bool silc_ske_parse_version(SilcSKE ske, 
+                           SilcUInt32 *protocol_version,
+                           char **protocol_version_string,
+                           SilcUInt32 *software_version, 
+                           char **software_version_string,
+                           char **vendor_version);
+
 #endif /* !SILCSKE_H */