lib/silcske/silcske.h

   1 /*
   2
   3   silcske.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2000 - 2007 Pekka Riikonen
   8
   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; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 /****h* silcske/SILC SKE Interface
  21  *
  22  * DESCRIPTION
  23  *
  24  * The SILC Key Exchange (SKE) protocol interface. The SKE protocol
  25  * is used to negotiate secret key material between two parties, to be used
  26  * as session key or some other key. For example, when client connects to
  27  * server SKE is performed to exchange public keys, and to generate the key
  28  * that is then used as session key. Two clients can execute SKE as well
  29  * two create secret key material for securing for example file transfer
  30  * stream. This SKE implementation provides easy interface for application
  31  * that wants to use SKE.
  32  *
  33  ***/
  34
  35 #ifndef SILCSKE_H
  36 #define SILCSKE_H
  37
  38 /* Forward declarations */
  39 typedef struct SilcSKECallbacksStruct *SilcSKECallbacks;
  40 typedef struct SilcSKEStruct *SilcSKE;
  41
  42 /****d* silcske/SilcSKEAPI/SilcSKEStatus
  43  *
  44  * NAME
  45  *
  46  *    typedef enum { ... } SilcSKEStatus;
  47  *
  48  * DESCRIPTION
  49  *
  50  *    Status types returned in SKE callbacks. This tell the status of
  51  *    the SKE session, and if an error occurred. Application can map the
  52  *    status to human readable string with silc_ske_map_status function.
  53  *
  54  * SOURCE
  55  */
  56 typedef enum {
  57   /* These are defined by the protocol */
  58   SILC_SKE_STATUS_OK                     = 0,  /* No error */
  59   SILC_SKE_STATUS_ERROR                  = 1,  /* Unknown error */
  60   SILC_SKE_STATUS_BAD_PAYLOAD            = 2,  /* Malformed payload */
  61   SILC_SKE_STATUS_UNKNOWN_GROUP          = 3,  /* Unsupported DH group */
  62   SILC_SKE_STATUS_UNKNOWN_CIPHER         = 4,  /* Unsupported cipher */
  63   SILC_SKE_STATUS_UNKNOWN_PKCS           = 5,  /* Unsupported PKCS algorithm */
  64   SILC_SKE_STATUS_UNKNOWN_HASH_FUNCTION  = 6,  /* Unsupported hash function */
  65   SILC_SKE_STATUS_UNKNOWN_HMAC           = 7,  /* Unsupported HMAC */
  66   SILC_SKE_STATUS_UNSUPPORTED_PUBLIC_KEY = 8,  /* Unsupported/not trusted PK */
  67   SILC_SKE_STATUS_INCORRECT_SIGNATURE    = 9,  /* Incorrect signature */
  68   SILC_SKE_STATUS_BAD_VERSION            = 10, /* Unsupported version */
  69   SILC_SKE_STATUS_INVALID_COOKIE         = 11, /* Cookie was modified */
  70
  71   /* Implementation specific status types */
  72   SILC_SKE_STATUS_PUBLIC_KEY_NOT_PROVIDED,     /* Remote did not send PK */
  73   SILC_SKE_STATUS_BAD_RESERVED_FIELD,          /* Reserved field was not 0 */
  74   SILC_SKE_STATUS_BAD_PAYLOAD_LENGTH,          /* Payload includes garbage */
  75   SILC_SKE_STATUS_SIGNATURE_ERROR,             /* Error computing signature */
  76   SILC_SKE_STATUS_OUT_OF_MEMORY,               /* System out of memory */
  77   SILC_SKE_STATUS_TIMEOUT,                     /* Timeout */
  78 } SilcSKEStatus;
  79 /***/
  80
  81 #include "silcske_groups.h"
  82 #include "silcske_payload.h"
  83
  84 /****d* silcske/SilcSKEAPI/SilcSKESecurityPropertyFlag
  85  *
  86  * NAME
  87  *
  88  *    typedef enum { ... } SilcSKESecurityPropertyFlag
  89  *
  90  * DESCRIPTION
  91  *
  92  *    SKE security property flags as defined by the SK protocol.
  93  *
  94  * SOURCE
  95  */
  96 typedef enum {
  97   SILC_SKE_SP_FLAG_NONE         = 0x00,  /* No flags */
  98   SILC_SKE_SP_FLAG_IV_INCLUDED  = 0x01,  /* IV included in packet */
  99   SILC_SKE_SP_FLAG_PFS          = 0x02,  /* Perfect Forward Secrecy */
 100   SILC_SKE_SP_FLAG_MUTUAL       = 0x04,  /* Mutual authentication */
 101 } SilcSKESecurityPropertyFlag;
 102 /***/
 103
 104 /****s* silcske/SilcSKEAPI/SilcSKESecurityProperties
 105  *
 106  * NAME
 107  *
 108  *    typedef struct { ... } *SilcSKESecurityProperties;
 109  *
 110  * DESCRIPTION
 111  *
 112  *    Security Properties negotiated between key exchange parties. This
 113  *    structure is filled from the Key Exchange Start Payload which is used
 114  *    to negotiate what security properties must be used in the
 115  *    communication.
 116  *
 117  * SOURCE
 118  */
 119 typedef struct SilcSKESecurityPropertiesStruct {
 120   SilcSKESecurityPropertyFlag flags;     /* Flags */
 121   SilcSKEDiffieHellmanGroup group;       /* Selected Diffie Hellman group */
 122   SilcCipher cipher;                     /* Selected cipher */
 123   SilcHmac hmac;                         /* Selected HMAC */
 124   SilcHash hash;                         /* Selected hash algorithm */
 125   SilcPublicKey public_key;              /* Remote public key */
 126   SilcUInt16 remote_port;                /* Remote port, set when IV Included
 127                                             set and using UDP/IP */
 128 } *SilcSKESecurityProperties;
 129 /***/
 130
 131 /****s* silcske/SilcSKEAPI/SilcSKEKeyMaterial
 132  *
 133  * NAME
 134  *
 135  *    typedef struct { ... } *SilcSKEKeyMaterial;
 136  *
 137  * DESCRIPTION
 138  *
 139  *    This is the key material structure, and is passed as argument by the
 140  *    application to silc_ske_process_key_material_data function. It includes
 141  *    the processed key material which can be used as SILC session keys.
 142  *
 143  * SOURCE
 144  */
 145 typedef struct SilcSKEKeyMaterialStruct {
 146   unsigned char *send_iv;
 147   unsigned char *receive_iv;
 148   SilcUInt32 iv_len;
 149   unsigned char *send_enc_key;
 150   unsigned char *receive_enc_key;
 151   SilcUInt32 enc_key_len;              /* Key length in bits */
 152   unsigned char *send_hmac_key;
 153   unsigned char *receive_hmac_key;
 154   SilcUInt32 hmac_key_len;             /* Key length in bytes */
 155 } *SilcSKEKeyMaterial;
 156 /***/
 157
 158 /****s* silcske/SilcSKEAPI/SilcSKERekeyMaterial
 159  *
 160  * NAME
 161  *
 162  *    typedef struct { ... } *SilcSKERekeyMaterial;
 163  *
 164  * DESCRIPTION
 165  *
 166  *    This context is returned after key exchange protocol to application
 167  *    in the completion callback.  Application may save it and use it later
 168  *    to perform the rekey with silc_ske_rekey_initiator and/or
 169  *    silc_ske_rekey_responder functions.  If application does not
 170  *    need the context, it may free it with silc_ske_free_rekey_material
 171  *    function.
 172  *
 173  ***/
 174 typedef struct SilcSKERekeyMaterialStruct {
 175   unsigned char *send_enc_key;
 176   char *hash;
 177   unsigned int enc_key_len  : 23;
 178   unsigned int ske_group    : 8;
 179   unsigned int pfs          : 1;
 180 } *SilcSKERekeyMaterial;
 181
 182 /****s* silcske/SilcSKEAPI/SilcSKEParams
 183  *
 184  * NAME
 185  *
 186  *    typedef struct { ... } *SilcSKEParams, SilcSKEParamsStruct;
 187  *
 188  * DESCRIPTION
 189  *
 190  *    SKE parameters structure.  This structure is given as argument to
 191  *    silc_ske_initiator and silc_ske_responder functions.
 192  *
 193  * SOURCE
 194  */
 195 typedef struct SilcSKEParamsObject {
 196   /* The SKE version string that is sent to the remote end.  This field
 197      must be set.  Caller must free the pointer. */
 198   char *version;
 199
 200   /* Security property flags.  When initiator sets these it requests them
 201      from the responder.  Responder may set here the flags it supports
 202      and wants to enforce for the initiator. */
 203   SilcSKESecurityPropertyFlag flags;
 204
 205   /* SILC Session port when using UDP/IP and SILC_SKE_SP_FLAG_IV_INCLUDED
 206      flag.  It is the port the remote will use as SILC session port after
 207      the key exchange protocol.  Ignored without SILC_SKE_SP_FLAG_IV_INCLUDED
 208      flag. */
 209   SilcUInt16 session_port;
 210
 211   /* Key exchange timeout in seconds.  If key exchange is not completed in
 212      this time it will timeout.  If not specified (zero), default value
 213      (30 seconds) will be used. */
 214   SilcUInt16 timeout_secs;
 215 } *SilcSKEParams, SilcSKEParamsStruct;
 216 /***/
 217
 218 /****d* silcske/SilcSKEAPI/SilcSKEPKType
 219  *
 220  * NAME
 221  *
 222  *    typedef enum { ... } SilcSKEPKType;
 223  *
 224  * DESCRIPTION
 225  *
 226  *    Public key and certificate types defined by the SKE protocol.
 227  *
 228  * SOURCE
 229  */
 230 typedef enum {
 231   SILC_SKE_PK_TYPE_SILC    = 1, /* SILC Public Key, mandatory */
 232   SILC_SKE_PK_TYPE_SSH2    = 2, /* SSH2 Public key, not supported */
 233   SILC_SKE_PK_TYPE_X509V3  = 3, /* X.509v3 certificate, not supported */
 234   SILC_SKE_PK_TYPE_OPENPGP = 4, /* OpenPGP certificate, not supported */
 235   SILC_SKE_PK_TYPE_SPKI    = 5  /* SPKI certificate, not supported */
 236 } SilcSKEPKType;
 237 /***/
 238
 239 /****f* silcske/SilcSKEAPI/SilcSKEVerifyCbCompletion
 240  *
 241  * SYNOPSIS
 242  *
 243  *    typedef void (*SilcSKEVerifyCbCompletion)(SilcSKE ske,
 244  *                                              SilcSKEStatus status,
 245  *                                              void *context);
 246  *
 247  * DESCRIPTION
 248  *
 249  *    Completion callback that will be called when the public key
 250  *    has been verified.  The `status' will indicate whether the public
 251  *    key were trusted or not.
 252  *
 253  ***/
 254 typedef void (*SilcSKEVerifyCbCompletion)(SilcSKE ske,
 255                                           SilcSKEStatus status,
 256                                           void *context);
 257
 258 /****f* silcske/SilcSKEAPI/SilcSKEVerifyCb
 259  *
 260  * SYNOPSIS
 261  *
 262  *    typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
 263  *                                    SilcPublicKey public_key,
 264  *                                    void *context,
 265  *                                    SilcSKEVerifyCbCompletion completion,
 266  *                                    void *completion_context);
 267  *
 268  * DESCRIPTION
 269  *
 270  *    Callback function used to verify the received public key or certificate.
 271  *    The verification process is most likely asynchronous.  That's why the
 272  *    application must call the `completion' callback when the verification
 273  *    process has been completed.  The `context' is the context given as
 274  *    arugment to silc_ske_set_callbacks.  See silc_ske_set_callbacks for
 275  *    more information.
 276  *
 277  *    If the key repository was provided in silc_ske_alloc this callback
 278  *    is called only if the public key was not found from the repository.
 279  *
 280  ***/
 281 typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
 282                                 SilcPublicKey public_key,
 283                                 void *context,
 284                                 SilcSKEVerifyCbCompletion completion,
 285                                 void *completion_context);
 286
 287 /****f* silcske/SilcSKEAPI/SilcSKECompletionCb
 288  *
 289  * SYNOPSIS
 290  *
 291  *    typedef void (*SilcSKECompletionCb)(SilcSKE ske,
 292  *                                        SilcSKEStatus status,
 293  *                                        const SilcSKESecurityProperties prop,
 294  *                                        const SilcSKEKeyMaterial keymat,
 295  *                                        SilcSKERekeyMaterial rekey,
 296  *                                        void *context);
 297  *
 298  * DESCRIPTION
 299  *
 300  *    Completion callback.  This is called after the key exchange protocol
 301  *    has been completed.  It delivers the status of the protocol, and if
 302  *    successful the security properties `prop' that was negotiated in the
 303  *    protocol and the key material `keymat' that can be set into use by
 304  *    calling silc_ske_set_keys, and the rekey key material `rekey' which
 305  *    can be used later to start rekey protocol.  The `prop' and `keymat'
 306  *    will remain valid as long as `ske' is valid.  The `rekey' will remain
 307  *    valid until silc_ske_free_rekey_material is called.  The application
 308  *    must call it to free the `rekey'.
 309  *
 310  *    When doing rekey, this completion callback delivers the `keymat' and
 311  *    new `rekey'.  The `prop' is ignored.  The `keymat' has already been set
 312  *    to the packet stream associated with the `ske'.  Thus, after this
 313  *    is called the new keys are in use.
 314  *
 315  ***/
 316 typedef void (*SilcSKECompletionCb)(SilcSKE ske,
 317                                     SilcSKEStatus status,
 318                                     const SilcSKESecurityProperties prop,
 319                                     const SilcSKEKeyMaterial keymat,
 320                                     SilcSKERekeyMaterial rekey,
 321                                     void *context);
 322
 323 /* Prototypes */
 324
 325 /****f* silcske/SilcSKEAPI/silc_ske_alloc
 326  *
 327  * SYNOPSIS
 328  *
 329  *    SilcSKE silc_ske_alloc(SilcRng rng, SilcSchedule schedule,
 330  *                           SilcSKR repository, SilcPublicKey public_key,
 331  *                           SilcPrivateKey private_key, void *context);
 332  *
 333  * DESCRIPTION
 334  *
 335  *    Allocates the SKE session context and returns it.  The `rng' is
 336  *    the random number generator the SKE is going to use when it needs
 337  *    random number generation during the SKE session.  The `context' is
 338  *    user context that the libary will not touch.  Application can get the
 339  *    context by calling the fuction silc_ske_get_context function.  The
 340  *    application is responsible of freeing the `context'.  After the
 341  *    SKE session context is allocated application must call the
 342  *    silc_ske_set_callbacks.
 343  *
 344  *    If the `repository' is non-NULL then the remote's public key will be
 345  *    verified from the repository.  If it is not provided then the
 346  *    SilcSKEVerifyCb callback must be set, and it will be called to
 347  *    verify the key.  If both `repository' and the callback is provided the
 348  *    callback is called only if the key is not found from the repository.
 349  *
 350  *    The `public_key' and `private_key' is the caller's identity used
 351  *    during the key exchange.  Giving `private_key' is optional if the
 352  *    SILC_SKE_SP_FLAG_MUTUAL is not set and you are initiator.  For
 353  *    responder both `public_key' and `private_key' must be set.
 354  *
 355  * EXMPALE
 356  *
 357  *    // Initiator example
 358  *    params.version = version;
 359  *    params.flags = SILC_SKE_SP_FLAG_PFS | SILC_SKE_SP_FLAG_MUTUAL;
 360  *    ske = silc_ske_alloc(rng, scheduler, NULL, pk, prv, app);
 361  *    silc_ske_set_callbacks(ske, verify_public_key, completion, app);
 362  *    silc_ske_initiator(ske, stream, &params, NULL);
 363  *
 364  ***/
 365 SilcSKE silc_ske_alloc(SilcRng rng, SilcSchedule schedule,
 366                        SilcSKR repository, SilcPublicKey public_key,
 367                        SilcPrivateKey private_key, void *context);
 368
 369 /****f* silcske/SilcSKEAPI/silc_ske_free
 370  *
 371  * SYNOPSIS
 372  *
 373  *    void silc_ske_free(SilcSKE ske);
 374  *
 375  * DESCRIPTION
 376  *
 377  *    Frees the SKE session context and all allocated resources.
 378  *
 379  ***/
 380 void silc_ske_free(SilcSKE ske);
 381
 382 /****f* silcske/SilcSKEAPI/silc_ske_get_context
 383  *
 384  * SYNOPSIS
 385  *
 386  *    void *silc_ske_get_context(SilcSKE ske);
 387  *
 388  * DESCRIPTION
 389  *
 390  *    Returns the context that was given as argument to silc_ske_alloc.
 391  *
 392  ***/
 393 void *silc_ske_get_context(SilcSKE ske);
 394
 395 /****f* silcske/SilcSKEAPI/silc_ske_set_callbacks
 396  *
 397  * SYNOPSIS
 398  *
 399  *    void silc_ske_set_callbacks(SilcSKE ske,
 400  *                                SilcSKEVerifyCb verify_key,
 401  *                                SilcSKECompletion completed,
 402  *                                void *context);
 403  *
 404  * DESCRIPTION
 405  *
 406  *    Sets the callback functions for the SKE session.
 407  *
 408  *    The `verify_key' callback is called to verify the received public key
 409  *    or certificate.  The verification process is most likely asynchronous.
 410  *    That is why the application must call the completion callback when the
 411  *    verification process has been completed.  If this SKE session context
 412  *    is used to perform  rekey, this callback usually is not provided as
 413  *    argument since sending public key in rekey is not mandatory.  Setting
 414  *    this callback implies that remote end MUST send its public key.
 415  *
 416  *    The `completed' callback will be called once the protocol has completed,
 417  *    either successfully or with an error.  The status of the protocol is
 418  *    delivered to application with the callback.
 419  *
 420  *    The `context' is passed as argument to all of the above callback
 421  *    functions.
 422  *
 423  ***/
 424 void silc_ske_set_callbacks(SilcSKE ske,
 425                             SilcSKEVerifyCb verify_key,
 426                             SilcSKECompletionCb completed,
 427                             void *context);
 428
 429 /****f* silcske/SilcSKEAPI/silc_ske_initiator
 430  *
 431  * SYNOPSIS
 432  *
 433  *    SilcAsyncOperation
 434  *    silc_ske_initiator(SilcSKE ske,
 435  *                       SilcPacketStream stream,
 436  *                       SilcSKEParams params,
 437  *                       SilcSKEStartPayload start_payload);
 438  *
 439  * DESCRIPTION
 440  *
 441  *    Starts the SILC Key Exchange protocol as initiator.  The completion
 442  *    callback that was set in silc_ske_set_callbacks will be called once
 443  *    the protocol has completed.  The `stream' is the network connection
 444  *    to the remote host.  The SKE library will handle all key exchange
 445  *    packets sent and received in the `stream' connection.  The library will
 446  *    also set the remote host's ID automatically to the `stream' if it is
 447  *    present in the exchanged packets.  The `params' include SKE parameters,
 448  *    and it must be provided.
 449  *
 450  *    If the `start_payload' is NULL the library will generate it
 451  *    automatically.  Caller may provide it if it wants to send its own
 452  *    security properties instead of using the default ones library
 453  *    generates.  If caller provides it, it must not free it once it has
 454  *    been given as argument to this function.
 455  *
 456  *    This function returns SilcAsyncOperation operation context which can
 457  *    be used to control the protocol from the application.  Application may
 458  *    for example safely abort the protocol at any point, if needed.  Returns
 459  *    NULL on error.
 460  *
 461  ***/
 462 SilcAsyncOperation silc_ske_initiator(SilcSKE ske,
 463                                       SilcPacketStream stream,
 464                                       SilcSKEParams params,
 465                                       SilcSKEStartPayload start_payload);
 466
 467 /****f* silcske/SilcSKEAPI/silc_ske_responder
 468  *
 469  * SYNOPSIS
 470  *
 471  *    SilcAsyncOperation
 472  *    silc_ske_responder(SilcSKE ske,
 473  *                       SilcPacketStream stream,
 474  *                       SilcSKEParams params);
 475  *
 476  * DESCRIPTION
 477  *
 478  *    Starts SILC Key Exchange protocol as responder.  The completion
 479  *    callback that was set in silc_ske_set_callbacks will be called once
 480  *    the protocol has completed.  The `stream' is the network connection
 481  *    to the remote host.  The SKE library will handle all key exchange
 482  *    packets sent and received in the `stream' connection.  The library will
 483  *    also set the remote hosts's ID automatically to the `stream' if it is
 484  *    present in the exchanged packets.  The `params' include SKE parameters,
 485  *    and must be provided.
 486  *
 487  *    This function returns SilcAsyncOperation operation context which can
 488  *    be used to control the protocol from the application.  Application may
 489  *    for example safely abort the protocol at any point, if needed.  Returns
 490  *    NULL on error.
 491  *
 492  ***/
 493 SilcAsyncOperation silc_ske_responder(SilcSKE ske,
 494                                       SilcPacketStream stream,
 495                                       SilcSKEParams params);
 496
 497 /****f* silcske/SilcSKEAPI/silc_ske_rekey_initiator
 498  *
 499  * SYNOPSIS
 500  *
 501  *    SilcAsyncOperation
 502  *    silc_ske_rekey_initiator(SilcSKE ske,
 503  *                             SilcPacketStream stream,
 504  *                             SilcSKERekeyMaterial rekey);
 505  *
 506  * DESCRIPTION
 507  *
 508  *    Starts SILC Key Exchange key regeneration (rekey) protocol.  The `rekey'
 509  *    is the rekey material received earlier in SilcSKECompletionCb.  That
 510  *    same callback is called after the rekey protocol is over to deliver new
 511  *    key material and new rekey material.  When the rekey is completed the
 512  *    SKE library will automatically update the new keys into `stream'.  The
 513  *    completion callback is called after the new keys has been taken into
 514  *    use.
 515  *
 516  *    This function returns SilcAsyncOperation operation context which can
 517  *    be used to control the protocol from the application.  Application may
 518  *    for example safely abort the protocol at any point, if needed.  Returns
 519  *    NULL on error.
 520  *
 521  ***/
 522 SilcAsyncOperation silc_ske_rekey_initiator(SilcSKE ske,
 523                                             SilcPacketStream stream,
 524                                             SilcSKERekeyMaterial rekey);
 525
 526 /****f* silcske/SilcSKEAPI/silc_ske_rekey_responder
 527  *
 528  * SYNOPSIS
 529  *
 530  *    SilcAsyncOperation
 531  *    silc_ske_rekey_responder(SilcSKE ske,
 532  *                             SilcPacketStream stream,
 533  *                             SilcSKERekeyMaterial rekey,
 534  *                             SilcPacket packet);
 535  *
 536  * DESCRIPTION
 537  *
 538  *    Starts SILC Key Exchange key regeneration (rekey) protocol as responder.
 539  *    The `rekey' is the rekey material received earlier in
 540  *    SilcSKECompletionCb.  That same callback is called after the rekey
 541  *    protocol is over to deliver new key material and new rekey material.
 542  *    When the rekey is completed the SKE library will automatically update
 543  *    the new keys into `stream'.  The completion callback is called after
 544  *    the new keys has been taken into use.
 545  *
 546  *    The `packet' is the SILC_PACKET_REKEY received to start the rekey
 547  *    protocol.  If `packet' is NULL it is assumed that the packet will be
 548  *    received from the `stream'.
 549  *
 550  *    This function returns SilcAsyncOperation operation context which can
 551  *    be used to control the protocol from the application.  Application may
 552  *    for example safely abort the protocol at any point, if needed.  Returns
 553  *    NULL on error.
 554  *
 555  ***/
 556 SilcAsyncOperation silc_ske_rekey_responder(SilcSKE ske,
 557                                             SilcPacketStream stream,
 558                                             SilcSKERekeyMaterial rekey,
 559                                             SilcPacket packet);
 560
 561 /****f* silcske/SilcSKEAPI/silc_ske_set_keys
 562  *
 563  * SYNOPSIS
 564  *
 565  *    SilcBool silc_ske_set_keys(SilcSKE ske,
 566  *                               SilcSKEKeyMaterial keymat,
 567  *                               SilcSKESecurityProperties prop,
 568  *                               SilcCipher *ret_send_key,
 569  *                               SilcCipher *ret_receive_key,
 570  *                               SilcHmac *ret_hmac_send,
 571  *                               SilcHmac *ret_hmac_receive,
 572  *                               SilcHash *ret_hash);
 573  *
 574  * DESCRIPTION
 575  *
 576  *    This function can be used after successful key exchange to take the
 577  *    key material `keymat' with security properties `prop' into use.
 578  *    This will allocate send and receive ciphers, HMACs and hash for the
 579  *    application.  Caller must free the returned contexts.  This is an
 580  *    utility function.
 581  *
 582  ***/
 583 SilcBool silc_ske_set_keys(SilcSKE ske,
 584                            SilcSKEKeyMaterial keymat,
 585                            SilcSKESecurityProperties prop,
 586                            SilcCipher *ret_send_key,
 587                            SilcCipher *ret_receive_key,
 588                            SilcHmac *ret_hmac_send,
 589                            SilcHmac *ret_hmac_receive,
 590                            SilcHash *ret_hash);
 591
 592 /****f* silcske/SilcSKEAPI/silc_ske_parse_version
 593  *
 594  * SYNOPSIS
 595  *
 596  *    SilcBool silc_ske_parse_version(SilcSKE ske,
 597  *                                    SilcUInt32 *protocol_version,
 598  *                                    char **protocol_version_string,
 599  *                                    SilcUInt32 *software_version,
 600  *                                    char **software_version_string,
 601  *                                    char **vendor_version);
 602  *
 603  * DESCRIPTION
 604  *
 605  *    Utility function to parse the remote host's version string.  This can
 606  *    be called after the key exchange has been completed.
 607  *
 608  ***/
 609 SilcBool silc_ske_parse_version(SilcSKE ske,
 610                                 SilcUInt32 *protocol_version,
 611                                 char **protocol_version_string,
 612                                 SilcUInt32 *software_version,
 613                                 char **software_version_string,
 614                                 char **vendor_version);
 615
 616 /****f* silcske/SilcSKEAPI/silc_ske_get_security_properties
 617  *
 618  * SYNOPSIS
 619  *
 620  *    SilcSKESecurityProperties silc_ske_get_security_properties(SilcSKE ske);
 621  *
 622  * DESCRIPTION
 623  *
 624  *    Returns negotiated security properties from the `ske' or NULL if they
 625  *    have not yet been negotiated.  This may be called to retrieve the
 626  *    security properties after the SilcSKECompletionCb has been called.
 627  *
 628  ***/
 629 SilcSKESecurityProperties silc_ske_get_security_properties(SilcSKE ske);
 630
 631 /****f* silcske/SilcSKEAPI/silc_ske_get_key_material
 632  *
 633  * SYNOPSIS
 634  *
 635  *    SilcSKEKeyMaterial silc_ske_get_key_material(SilcSKE ske);
 636  *
 637  * DESCRIPTION
 638  *
 639  *    Returns the negotiated key material from the `ske' or NULL if the
 640  *    key material does not exist.  The caller must not free the returned
 641  *    pointer.
 642  *
 643  ***/
 644 SilcSKEKeyMaterial silc_ske_get_key_material(SilcSKE ske);
 645
 646 /****f* silcske/SilcSKEAPI/silc_ske_process_key_material_data
 647  *
 648  * SYNOPSIS
 649  *
 650  *    const char *silc_ske_map_status(SilcSKEStatus status);
 651  *
 652  * DESCRIPTION
 653  *
 654  *    Utility function to process key data `data' in the way specified
 655  *    by the SILC Key Exchange protocol.  This returns the processed key
 656  *    material or NULL on error.  Caller must free the returned key
 657  *    material context by calling silc_ske_free_key_material.
 658  *
 659  ***/
 660 SilcSKEKeyMaterial
 661 silc_ske_process_key_material_data(unsigned char *data,
 662                                    SilcUInt32 data_len,
 663                                    SilcUInt32 req_iv_len,
 664                                    SilcUInt32 req_enc_key_len,
 665                                    SilcUInt32 req_hmac_key_len,
 666                                    SilcHash hash);
 667
 668 /****f* silcske/SilcSKEAPI/silc_ske_free_key_material
 669  *
 670  * SYNOPSIS
 671  *
 672  *    void silc_ske_free_key_material(SilcSKEKeyMaterial key)
 673  *
 674  * DESCRIPTION
 675  *
 676  *    Utility function to free the key material created by calling
 677  *    silc_ske_process_key_material_data.
 678  *
 679  ***/
 680 void silc_ske_free_key_material(SilcSKEKeyMaterial key);
 681
 682 /****f* silcske/SilcSKEAPI/silc_ske_free_rekey_material
 683  *
 684  * SYNOPSIS
 685  *
 686  *    void silc_ske_free_rekey_material(SilcSKERekeyMaterial rekey);
 687  *
 688  * DESCRIPTION
 689  *
 690  *    Utility function to free the rekey material returned in the
 691  *    SilcSKECompletionCb callback.
 692  *
 693  ***/
 694 void silc_ske_free_rekey_material(SilcSKERekeyMaterial rekey);
 695
 696 /****f* silcske/SilcSKEAPI/silc_ske_map_status
 697  *
 698  * SYNOPSIS
 699  *
 700  *    const char *silc_ske_map_status(SilcSKEStatus status);
 701  *
 702  * DESCRIPTION
 703  *
 704  *    Utility function to map the `status' into human readable message.
 705  *
 706  ***/
 707 const char *silc_ske_map_status(SilcSKEStatus status);
 708
 709 #include "silcske_i.h"
 710
 711 #endif  /* !SILCSKE_H */