X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilccrypt%2Fsilcpkcs.h;h=2fd34f7490650fb731eda7c30007401524b1f626;hb=e7b6c157b80152bf9fb9266e6bdd93f9fb0db776;hp=86bab7336bb6da4ebc1790b7434607e4b3a94bc4;hpb=f82024f04b73e3b80ddd6c590699206d3dc5c1eb;p=silc.git diff --git a/lib/silccrypt/silcpkcs.h b/lib/silccrypt/silcpkcs.h index 86bab733..2fd34f74 100644 --- a/lib/silccrypt/silcpkcs.h +++ b/lib/silccrypt/silcpkcs.h @@ -2,15 +2,14 @@ silcpkcs.h - Author: Pekka Riikonen + Author: Pekka Riikonen - Copyright (C) 1997 - 2001 Pekka Riikonen + Copyright (C) 1997 - 2007 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - + the Free Software Foundation; version 2 of the License. + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the @@ -18,238 +17,809 @@ */ +/****h* silccrypt/SILC PKCS Interface + * + * DESCRIPTION + * + * SILC PKCS API provides generic interface for performing various + * public key cryptography related operations with different types of + * public and private keys. Support for loading and saving of different + * types of public key and private keys are also provided. + * + ***/ + #ifndef SILCPKCS_H #define SILCPKCS_H -/* The default SILC PKCS (Public Key Cryptosystem) object to represent - any PKCS in SILC. */ -typedef struct SilcPKCSObjectStruct { - char *name; - int (*init)(void *, SilcUInt32, SilcRng); - void (*clear_keys)(void *); - unsigned char *(*get_public_key)(void *, SilcUInt32 *); - unsigned char *(*get_private_key)(void *, SilcUInt32 *); - SilcUInt32 (*set_public_key)(void *, unsigned char *, SilcUInt32); - int (*set_private_key)(void *, unsigned char *, SilcUInt32); - SilcUInt32 (*context_len)(); - int (*encrypt)(void *, unsigned char *, SilcUInt32, - unsigned char *, SilcUInt32 *); - int (*decrypt)(void *, unsigned char *, SilcUInt32, - unsigned char *, SilcUInt32 *); - int (*sign)(void *, unsigned char *, SilcUInt32, - unsigned char *, SilcUInt32 *); - int (*verify)(void *, unsigned char *, SilcUInt32, - unsigned char *, SilcUInt32); -} SilcPKCSObject; - -/* The main SILC PKCS structure. Use SilcPKCS instead of SilcPKCSStruct. - Also remember that SilcPKCS is a pointer. */ -typedef struct SilcPKCSStruct { - void *context; - SilcPKCSObject *pkcs; - SilcUInt32 key_len; - - SilcUInt32 (*get_key_len)(struct SilcPKCSStruct *); -} *SilcPKCS; - -/* SILC style public key object. Public key is read from file to this - object. Public keys received from network must be in this format as - well. */ -typedef struct { - SilcUInt32 len; - char *name; - char *identifier; - unsigned char *pk; - SilcUInt32 pk_len; +/* Forward declarations */ +typedef struct SilcPKCSAlgorithmStruct SilcPKCSAlgorithm; +typedef struct SilcPKCSObjectStruct SilcPKCSObject; + +/****d* silccrypt/SilcPKCSAPI/SilcPKCSType + * + * NAME + * + * typedef enum { ... } SilcPKCSType; + * + * DESCRIPTION + * + * Supported public key cryptosystem types. + * + * SOURCE + */ +typedef enum { + SILC_PKCS_SILC = 1, /* SILC PKCS */ + SILC_PKCS_SSH2 = 2, /* SSH2 PKCS */ + SILC_PKCS_X509V3 = 3, /* X.509v3 PKCS */ + SILC_PKCS_OPENPGP = 4, /* OpenPGP PKCS */ + SILC_PKCS_SPKI = 5, /* SPKI PKCS (not supported) */ + SILC_PKCS_ANY = 0, +} SilcPKCSType; +/***/ + +/****s* silccrypt/SilcPKCSAPI/SilcPublicKey + * + * NAME + * + * typedef struct { ... } *SilcPublicKey; + * + * DESCRIPTION + * + * This context represents any kind of PKCS public key. It can be + * allocated by silc_pkcs_public_key_alloc and is freed by the + * silc_pkcs_public_key_free. The PKCS specific public key context + * can be retrieved by calling silc_pkcs_public_key_get_pkcs. + * + * SOURCE + */ +typedef struct SilcPublicKeyStruct { + SilcPKCSObject *pkcs; /* PKCS */ + const SilcPKCSAlgorithm *alg; /* PKCS algorithm */ + void *public_key; /* PKCS specific public key */ } *SilcPublicKey; +/***/ -/* SILC style private key object. Private key is read from file to this - object. */ -typedef struct { - char *name; - unsigned char *prv; - SilcUInt32 prv_len; +/****s* silccrypt/SilcPKCSAPI/SilcPrivateKey + * + * NAME + * + * typedef struct { ... } *SilcPrivateKey; + * + * DESCRIPTION + * + * This context represents any kind of PKCS private key. The PKCS specific + * key context can be retrieved by calling silc_pkcs_private_key_get_pkcs. + * + * SOURCE + */ +typedef struct SilcPrivateKeyStruct { + SilcPKCSObject *pkcs; /* PKCS */ + const SilcPKCSAlgorithm *alg; /* PKCS algorithm */ + void *private_key; /* PKCS specific private key */ } *SilcPrivateKey; +/***/ + +/****d* silccrypt/SilcPKCSAPI/SilcPKCSFileEncoding + * + * NAME + * + * typedef enum { ... } SilcPKCSType + * + * DESCRIPTION + * + * Public and private key file encoding types. + * + * SOURCE + */ +typedef enum { + SILC_PKCS_FILE_BIN, /* Binary encoding */ + SILC_PKCS_FILE_BASE64 /* Base64 encoding */ +} SilcPKCSFileEncoding; +/***/ + +/****f* silccrypt/SilcPKCSAPI/SilcPKCSEncryptCb + * + * SYNOPSIS + * + * typedef void (*SilcPKCSEncryptCb)(SilcBool success, + * const unsigned char *encrypted, + * SilcUInt32 encrypted_len, + * void *context); + * + * DESCRIPTION + * + * Encryption callback. This callback is given as argument to the + * silc_pkcs_encrypt and the encrypted data is delivered to the caller + * in this callback. The `encrypted' is the encrypted data. If the + * `success' is FALSE the encryption operation failed. + * + ***/ +typedef void (*SilcPKCSEncryptCb)(SilcBool success, + const unsigned char *encrypted, + SilcUInt32 encrypted_len, + void *context); -/* Decoded SILC Public Key identifier. Note that some of the fields - may be NULL. */ -typedef struct { - char *username; - char *host; - char *realname; - char *email; - char *org; - char *country; -} *SilcPublicKeyIdentifier; - -/* Public and private key file headers */ -#define SILC_PKCS_PUBLIC_KEYFILE_BEGIN "-----BEGIN SILC PUBLIC KEY-----\n" -#define SILC_PKCS_PUBLIC_KEYFILE_END "\n-----END SILC PUBLIC KEY-----\n" -#define SILC_PKCS_PRIVATE_KEYFILE_BEGIN "-----BEGIN SILC PRIVATE KEY-----\n" -#define SILC_PKCS_PRIVATE_KEYFILE_END "\n-----END SILC PRIVATE KEY-----\n" - -/* Public and private key file encoding types */ -#define SILC_PKCS_FILE_BIN 0 -#define SILC_PKCS_FILE_PEM 1 - -/* Marks for all PKCS in silc. This can be used in silc_pkcs_unregister - to unregister all PKCS at once. */ +/****f* silccrypt/SilcPKCSAPI/SilcPKCSDecryptCb + * + * SYNOPSIS + * + * typedef void (*SilcPKCSDecryptCb)(SilcBool success, + * const unsigned char *decrypted, + * SilcUInt32 decrypted_len, + * void *context); + * + * DESCRIPTION + * + * Decryption callback. This callback is given as argument to the + * silc_pkcs_decrypt and the decrypted data is delivered to the caller + * in this callback. The `decrypted' is the decrypted data. If the + * `success' is FALSE the decryption operation failed. + * + ***/ +typedef void (*SilcPKCSDecryptCb)(SilcBool success, + const unsigned char *decrypted, + SilcUInt32 decrypted_len, + void *context); + +/****f* silccrypt/SilcPKCSAPI/SilcPKCSSignCb + * + * SYNOPSIS + * + * typedef void (*SilcPKCSSignCb)(SilcBool success, + * const unsigned char *signature, + * SilcUInt32 signature_len, + * void *context); + * + * DESCRIPTION + * + * Signature callback. This callback is given as argument to the + * silc_pkcs_sign and the digitally signed data is delivered to the caller + * in this callback. The `signature' is the signature data. If the + * `success' is FALSE the signature operation failed. + * + ***/ +typedef void (*SilcPKCSSignCb)(SilcBool success, + const unsigned char *signature, + SilcUInt32 signature_len, + void *context); + +/****f* silccrypt/SilcPKCSAPI/SilcPKCSVerifyCb + * + * SYNOPSIS + * + * typedef void (*SilcPKCSVerifyCb)(SilcBool success, void *context); + * + * DESCRIPTION + * + * Verification callback. This callback is given as argument to the + * silc_pkcs_verify and the result of the signature verification is + * deliver to the caller in this callback. If the `success' is FALSE + * the signature verification failed. + * + ***/ +typedef void (*SilcPKCSVerifyCb)(SilcBool success, void *context); + +#include "silcpkcs_i.h" + +/* Marks for all PKCS in. This can be used in silc_pkcs_unregister to + unregister all PKCS at once. */ #define SILC_ALL_PKCS ((SilcPKCSObject *)1) +#define SILC_ALL_PKCS_ALG ((SilcPKCSAlgorithm *)1) -/* Static list of PKCS for silc_pkcs_register_default(). */ +/* Static lists of PKCS and PKCS algorithms. */ extern DLLAPI const SilcPKCSObject silc_default_pkcs[]; +extern DLLAPI const SilcPKCSAlgorithm silc_default_pkcs_alg[]; -/* Default PKXS in the SILC protocol */ -#define SILC_DEFAULT_PKCS "rsa" +/* Prototypes */ -/* Macros */ +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_register + * + * SYNOPSIS + * + * SilcBool silc_pkcs_register(const SilcPKCSObject *pkcs); + * + * DESCRIPTION + * + * Registers a new PKCS into the crypto library. This function is used + * at the initialization of an application. All registered PKCSs + * should be unregistered with silc_pkcs_unregister. The `pkcs' includes + * the name of the PKCS and member functions for the algorithm. Usually + * this function is not called directly. Instead, application can call + * the silc_pkcs_register_default to register all PKCSs that are + * builtin the sources. Returns FALSE on error. + * + ***/ +SilcBool silc_pkcs_register(const SilcPKCSObject *pkcs); -/* Macros used to implement the SILC PKCS API */ +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_unregister + * + * SYNOPSIS + * + * SilcBool silc_pkcs_unregister(SilcPKCSObject *pkcs); + * + * DESCRIPTION + * + * Unregister a PKCS from the crypto library. Returns FALSE on error. + * + ***/ +SilcBool silc_pkcs_unregister(SilcPKCSObject *pkcs); -/* XXX: This needs slight redesigning. These needs to be made even - more generic. I don't like that the actual prime generation is done - in PKCS_API_INIT. The primes used in key generation should be sent - as argument to the init function. By doing this we would achieve - that PKCS could be used as SIM's. The only requirement would be - that they are compiled against GMP (well, actually even that would - not be a requirement, but the most generic case anyway). The new init - would look something like this: +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_algorithm_register + * + * SYNOPSIS + * + * SilcBool silc_pkcs_algorithm_register(const SilcPKCSAlgorithm *pkcs); + * + * DESCRIPTION + * + * Registers a new PKCS Algorithm into crypto library. This function + * is used at the initialization of an application. All registered PKCS +* algorithms should be unregistered with silc_pkcs_unregister. + * + ***/ +SilcBool silc_pkcs_algorithm_register(const SilcPKCSAlgorithm *pkcs); - #define SILC_PKCS_API_INIT(pkcs) \ - inline int silc_##pkcs##_init(void *context, SilcUInt32 keylen, \ - void *p1, void *p2) +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_algorithm_unregister + * + * SYNOPSIS + * + * SilcBool silc_pkcs_algorithm_unregister(SilcPKCSAlgorithm *pkcs); + * + * DESCRIPTION + * + * Unregister a PKCS from the crypto library. Returns FALSE on error. + * + ***/ +SilcBool silc_pkcs_algorithm_unregister(SilcPKCSAlgorithm *pkcs); - Now we wouldn't have to send the SilcRng object since the primes are - provided as arguments. To send them as void * they could actually be - used as in anyway for real (MP_INT (SilcMPInt) or even something else - (the pointer could be kludged to be something else in the module)) - (Plus, the SilcRng object management in prime generation would be - simpler and better what it is now (in silcprimegen.c, that is)). -*/ +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_register_default + * + * SYNOPSIS + * + * SilcBool silc_pkcs_register_default(void); + * + * DESCRIPTION + * + * Registers all the default PKCS (all builtin PKCS) and PKCS algorithms. + * The application may use this to register the default PKCS if specific + * PKCS in any specific order is not wanted. Returns FALSE on error. + * + ***/ +SilcBool silc_pkcs_register_default(void); -#define SILC_PKCS_API_INIT(pkcs) \ -int silc_##pkcs##_init(void *context, SilcUInt32 keylen, \ - SilcRng rng) -#define SILC_PKCS_API_CLEAR_KEYS(pkcs) \ -void silc_##pkcs##_clear_keys(void *context) -#define SILC_PKCS_API_GET_PUBLIC_KEY(pkcs) \ -unsigned char *silc_##pkcs##_get_public_key(void *context, \ - SilcUInt32 *ret_len) -#define SILC_PKCS_API_GET_PRIVATE_KEY(pkcs) \ -unsigned char *silc_##pkcs##_get_private_key(void *context, \ - SilcUInt32 *ret_len) -#define SILC_PKCS_API_SET_PUBLIC_KEY(pkcs) \ -SilcUInt32 silc_##pkcs##_set_public_key(void *context, unsigned char *key_data, \ - SilcUInt32 key_len) -#define SILC_PKCS_API_SET_PRIVATE_KEY(pkcs) \ -int silc_##pkcs##_set_private_key(void *context, unsigned char *key_data, \ - SilcUInt32 key_len) -#define SILC_PKCS_API_CONTEXT_LEN(pkcs) \ -SilcUInt32 silc_##pkcs##_context_len() -#define SILC_PKCS_API_ENCRYPT(pkcs) \ -int silc_##pkcs##_encrypt(void *context, \ - unsigned char *src, \ - SilcUInt32 src_len, \ - unsigned char *dst, \ - SilcUInt32 *dst_len) -#define SILC_PKCS_API_DECRYPT(pkcs) \ -int silc_##pkcs##_decrypt(void *context, \ - unsigned char *src, \ - SilcUInt32 src_len, \ - unsigned char *dst, \ - SilcUInt32 *dst_len) -#define SILC_PKCS_API_SIGN(pkcs) \ -int silc_##pkcs##_sign(void *context, \ - unsigned char *src, \ - SilcUInt32 src_len, \ - unsigned char *dst, \ - SilcUInt32 *dst_len) -#define SILC_PKCS_API_VERIFY(pkcs) \ -int silc_##pkcs##_verify(void *context, \ - unsigned char *signature, \ - SilcUInt32 signature_len, \ - unsigned char *data, \ - SilcUInt32 data_len) +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_unregister_all + * + * SYNOPSIS + * + * SilcBool silc_pkcs_unregister_all(void); + * + * DESCRIPTION + * + * Unregister all PKCS and PKCS algorithms. Returns FALSE on error. + * + ***/ +SilcBool silc_pkcs_unregister_all(void); -/* Prototypes */ -bool silc_pkcs_register(const SilcPKCSObject *pkcs); -bool silc_pkcs_unregister(SilcPKCSObject *pkcs); -bool silc_pkcs_register_default(void); -bool silc_pkcs_alloc(const unsigned char *name, SilcPKCS *new_pkcs); -void silc_pkcs_free(SilcPKCS pkcs); -int silc_pkcs_is_supported(const unsigned char *name); +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_get_supported + * + * SYNOPSIS + * + * char *silc_pkcs_get_supported(void); + * + * DESCRIPTION + * + * Returns comma separated list of supported PKCS algorithms. + * + ***/ char *silc_pkcs_get_supported(void); -int silc_pkcs_generate_key(SilcPKCS pkcs, SilcUInt32 bits_key_len, - SilcRng rng); -SilcUInt32 silc_pkcs_get_key_len(SilcPKCS self); -unsigned char *silc_pkcs_get_public_key(SilcPKCS pkcs, SilcUInt32 *len); -unsigned char *silc_pkcs_get_private_key(SilcPKCS pkcs, SilcUInt32 *len); -SilcUInt32 silc_pkcs_public_key_set(SilcPKCS pkcs, SilcPublicKey public_key); -SilcUInt32 silc_pkcs_public_key_data_set(SilcPKCS pkcs, unsigned char *pk, - SilcUInt32 pk_len); -int silc_pkcs_private_key_set(SilcPKCS pkcs, SilcPrivateKey private_key); -int silc_pkcs_private_key_data_set(SilcPKCS pkcs, unsigned char *prv, - SilcUInt32 prv_len); -int silc_pkcs_encrypt(SilcPKCS pkcs, unsigned char *src, SilcUInt32 src_len, - unsigned char *dst, SilcUInt32 *dst_len); -int silc_pkcs_decrypt(SilcPKCS pkcs, unsigned char *src, SilcUInt32 src_len, - unsigned char *dst, SilcUInt32 *dst_len); -int silc_pkcs_sign(SilcPKCS pkcs, unsigned char *src, SilcUInt32 src_len, - unsigned char *dst, SilcUInt32 *dst_len); -int silc_pkcs_verify(SilcPKCS pkcs, unsigned char *signature, - SilcUInt32 signature_len, unsigned char *data, - SilcUInt32 data_len); -int silc_pkcs_sign_with_hash(SilcPKCS pkcs, SilcHash hash, - unsigned char *src, SilcUInt32 src_len, - unsigned char *dst, SilcUInt32 *dst_len); -int silc_pkcs_verify_with_hash(SilcPKCS pkcs, SilcHash hash, - unsigned char *signature, - SilcUInt32 signature_len, - unsigned char *data, - SilcUInt32 data_len); -char *silc_pkcs_encode_identifier(char *username, char *host, char *realname, - char *email, char *org, char *country); -SilcPublicKeyIdentifier silc_pkcs_decode_identifier(char *identifier); -void silc_pkcs_free_identifier(SilcPublicKeyIdentifier identifier); -SilcPublicKey silc_pkcs_public_key_alloc(char *name, char *identifier, - unsigned char *pk, - SilcUInt32 pk_len); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_find_pkcs + * + * SYNOPSIS + * + * const SilcPKCSObject *silc_pkcs_get_pkcs(SilcPKCSType type); + * + * DESCRIPTION + * + * Finds PKCS context by the PKCS type. + * + ***/ +const SilcPKCSObject *silc_pkcs_find_pkcs(SilcPKCSType type); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_find_algorithm + * + * SYNOPSIS + * + * const SilcPKCSAlgorithm *silc_pkcs_find_algorithm(const char *algorithm, + * const char *scheme); + * + * DESCRIPTION + * + * Finds PKCS algorithm context by the algorithm name `algorithm' and + * the algorithm scheme `scheme'. The `scheme' may be NULL. + * + ***/ +const SilcPKCSAlgorithm *silc_pkcs_find_algorithm(const char *algorithm, + const char *scheme); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_get_pkcs + * + * SYNOPSIS + * + * const SilcPKCSObject *silc_pkcs_get_pkcs(void *key); + * + * DESCRIPTION + * + * Returns the PKCS object from `key', which may be SilcPublicKey or + * SilcPrivateKey pointer. + * + ***/ +const SilcPKCSObject *silc_pkcs_get_pkcs(void *key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_get_algorithm + * + * SYNOPSIS + * + * const SilcPKCSAlgorithm *silc_pkcs_get_algorithm(void *key); + * + * DESCRIPTION + * + * Returns the PKCS algorithm object from `key', which may be SilcPublicKey + * or SilcPrivateKey pointer. + * + ***/ +const SilcPKCSAlgorithm *silc_pkcs_get_algorithm(void *key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_get_name + * + * SYNOPSIS + * + * const char *silc_pkcs_get_name(void *key); + * + * DESCRIPTION + * + * Returns PKCS algorithm name from the `key', which may be SilcPublicKey + * or SilcPrivateKey pointer. + * + ***/ +const char *silc_pkcs_get_name(void *key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_get_type + * + * SYNOPSIS + * + * SilcPKCSType silc_pkcs_get_type(void *key); + * + * DESCRIPTION + * + * Returns PKCS type from the `key', which may be SilcPublicKey or + * SilcPrivateKey pointer. + * + ***/ +SilcPKCSType silc_pkcs_get_type(void *key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_get_pkcs + * + * SYNOPSIS + * + * void *silc_pkcs_public_key_get_pkcs(SilcPKCSType type, + * SilcPublicKey public_key); + * + * DESCRIPTION + * + * Returns the internal PKCS `type' specific public key context from the + * `public_key'. The caller needs to explicitly type cast it to correct + * type. Returns NULL on error. + * + * For SILC_PKCS_SILC the returned context is SilcSILCPublicKey. + * For SILC_PKCS_SSH2 the returned context is SilcSshPublicKey. + * + ***/ +void *silc_pkcs_public_key_get_pkcs(SilcPKCSType type, + SilcPublicKey public_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_private_key_get_pkcs + * + * SYNOPSIS + * + * void *silc_pkcs_private_key_get_pkcs(SilcPKCSType type, + * SilcPublicKey public_key); + * + * DESCRIPTION + * + * Returns the internal PKCS `type' specific private key context from the + * `private_key'. The caller needs to explicitly type cast it to correct + * type. Returns NULL on error. + * + * For SILC_PKCS_SILC the returned context is SilcSILCPrivateKey. + * For SILC_PKCS_SSH2 the returned context is SilcSshPrivateKey. + * + ***/ +void *silc_pkcs_private_key_get_pkcs(SilcPKCSType type, + SilcPrivateKey private_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_alloc + * + * SYNOPSIS + * + * SilcBool silc_pkcs_public_key_alloc(SilcPKCSType type, + * unsigned char *key, + * SilcUInt32 key_len + * SilcPublicKey *ret_public_key); + * + * DESCRIPTION + * + * Allocates SilcPublicKey of the type of `type' from the key data + * `key' of length of `key_len' bytes. Returns FALSE if the `key' + * is malformed or unsupported public key type. This function can be + * used to create public key from any kind of PKCS public keys that + * the implementation supports. + * + ***/ +SilcBool silc_pkcs_public_key_alloc(SilcPKCSType type, + unsigned char *key, + SilcUInt32 key_len, + SilcPublicKey *ret_public_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_free + * + * SYNOPSIS + * + * void silc_pkcs_public_key_free(SilcPublicKey public_key); + * + * DESCRIPTION + * + * Frees the public key. This will also automatically free the underlaying + * PKCS specific public key. All public keys allocated through the + * PKCS API must be freed by calling this function. + * + ***/ void silc_pkcs_public_key_free(SilcPublicKey public_key); -SilcPrivateKey silc_pkcs_private_key_alloc(char *name, unsigned char *prv, - SilcUInt32 prv_len); -void silc_pkcs_private_key_free(SilcPrivateKey private_key); -unsigned char * -silc_pkcs_public_key_encode(SilcPublicKey public_key, SilcUInt32 *len); -unsigned char * -silc_pkcs_public_key_data_encode(unsigned char *pk, SilcUInt32 pk_len, - char *pkcs, char *identifier, - SilcUInt32 *len); -int silc_pkcs_public_key_decode(unsigned char *data, SilcUInt32 data_len, - SilcPublicKey *public_key); -bool silc_pkcs_public_key_compare(SilcPublicKey key1, SilcPublicKey key2); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_export + * + * SYNOPSIS + * + * unsigned char *silc_pkcs_public_key_encode(SilcStack stack, + * SilcPublicKey public_key, + * SilcUInt32 *ret_len); + * + * DESCRIPTION + * + * Encodes the `public_key' into a binary format and returns it. Returns + * NULL on error. Caller must free the returned buffer. + * + * If the `stack' is non-NULL the returned buffer is allocated from the + * `stack'. This call will consume `stack' so caller should push the stack + * before calling and then later pop it. + * + ***/ +unsigned char *silc_pkcs_public_key_encode(SilcStack stack, + SilcPublicKey public_key, + SilcUInt32 *ret_len); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_get_len + * + * SYNOPSIS + * + * SilcUInt32 silc_pkcs_public_key_get_len(SilcPublicKey public_key); + * + * DESCRIPTION + * + * Returns the key length in bits from the public key. + * + ***/ +SilcUInt32 silc_pkcs_public_key_get_len(SilcPublicKey public_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_compare + * + * SYNOPSIS + * + * SilcBool silc_pkcs_public_key_compare(SilcPublicKey key1, + * SilcPublicKey key2); + * + * DESCRIPTION + * + * Compares two public keys and returns TRUE if they are same key, and + * FALSE if they are not same. + * + ***/ +SilcBool silc_pkcs_public_key_compare(SilcPublicKey key1, SilcPublicKey key2); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_public_key_copy + * + * SYNOPSIS + * + * SilcPublicKey silc_pkcs_public_key_copy(SilcPublicKey public_key); + * + * DESCRIPTION + * + * Copies the public key indicated by `public_key' and returns new + * allocated public key which is indentical to the `public_key'. + * + ***/ SilcPublicKey silc_pkcs_public_key_copy(SilcPublicKey public_key); -unsigned char * -silc_pkcs_private_key_encode(SilcPrivateKey private_key, SilcUInt32 *len); -unsigned char * -silc_pkcs_private_key_data_encode(unsigned char *prv, SilcUInt32 prv_len, - char *pkcs, SilcUInt32 *len); -int silc_pkcs_private_key_decode(unsigned char *data, SilcUInt32 data_len, - SilcPrivateKey *private_key); -int silc_pkcs_save_public_key(char *filename, SilcPublicKey public_key, - SilcUInt32 encoding); -int silc_pkcs_save_public_key_data(char *filename, unsigned char *data, - SilcUInt32 data_len, - SilcUInt32 encoding); -int silc_pkcs_save_private_key(char *filename, SilcPrivateKey private_key, - unsigned char *passphrase, - SilcUInt32 encoding); -int silc_pkcs_save_private_key_data(char *filename, unsigned char *data, + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_private_key_alloc + * + * SYNOPSIS + * + * SilcBool silc_pkcs_private_key_alloc(SilcPKCSType type, + * unsigned char *key, + * SilcUInt32 key_len, + * SilcPrivateKey *ret_private_key); + * + * DESCRIPTION + * + * Allocates SilcPrivateKey of the type of `type' from the key data + * `key' of length of `key_len' bytes. Returns FALSE if the `key' + * is malformed or unsupported private key type. + * + ***/ +SilcBool silc_pkcs_private_key_alloc(SilcPKCSType type, + unsigned char *key, + SilcUInt32 key_len, + SilcPrivateKey *ret_private_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_private_key_get_len + * + * SYNOPSIS + * + * SilcUInt32 silc_pkcs_private_key_get_len(SilcPrivateKey private_key); + * + * DESCRIPTION + * + * Returns the key length in bits from the private key. + * + ***/ +SilcUInt32 silc_pkcs_private_key_get_len(SilcPrivateKey private_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_private_key_free + * + * SYNOPSIS + * + * void silc_pkcs_private_key_free(SilcPrivateKey private_key; + * + * DESCRIPTION + * + * Frees the public key. This will also automatically free the underlaying + * PKCS specific private key. All private keys allocated through the + * PKCS API must be freed by calling this function. + * + ***/ +void silc_pkcs_private_key_free(SilcPrivateKey private_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_encrypt + * + * SYNOPSIS + * + * SilcAsyncOperation silc_pkcs_encrypt(SilcPublicKey public_key, + * unsigned char *src, + * SilcUInt32 src_len, SilcRng rng, + * SilcPKCSEncryptCb encrypt_cb, + * void *context); + * + * DESCRIPTION + * + * Encrypts with the public key. The `encrypt_cb' will be called to + * deliver the encrypted data. The encryption operation may be asynchronous + * if the `public_key' is accelerated public key. If this returns NULL + * the asynchronous operation cannot be controlled. + * + ***/ +SilcAsyncOperation silc_pkcs_encrypt(SilcPublicKey public_key, + unsigned char *src, + SilcUInt32 src_len, SilcRng rng, + SilcPKCSEncryptCb encrypt_cb, + void *context); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_decrypt + * + * SYNOPSIS + * + * SilcAsyncOperation silc_pkcs_decrypt(SilcPrivateKey private_key, + * unsigned char *src, + * SilcUInt32 src_len, + * SilcPKCSDecryptCb decrypt_cb, + * void *context); + * + * DESCRIPTION + * + * Decrypts with the private key. The `decrypt_cb' will be called to + * deliver the decrypted data. The decryption operation may be asynchronous + * if the `private_key' is accelerated private key. If this returns NULL + * the asynchronous operation cannot be controlled. + * + ***/ +SilcAsyncOperation silc_pkcs_decrypt(SilcPrivateKey private_key, + unsigned char *src, SilcUInt32 src_len, + SilcPKCSDecryptCb decrypt_cb, + void *context); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_sign + * + * SYNOPSIS + * + * SilcAsyncOperation silc_pkcs_sign(SilcPrivateKey private_key, + * unsigned char *src, + * SilcUInt32 src_len, + * SilcBool compute_hash, + * SilcHash hash, + * SilcRng rng, + * SilcPKCSSignCb sign_cb, + * void *context); + * + * DESCRIPTION + * + * Computes signature with the private key. The `sign_cb' will be called + * to deliver the signature data. If `compute_hash' is TRUE the `hash' + * will be used to compute a message digest over the `src'. The `hash' + * must always be valid. The `rng' should always be provided. The + * signature operation may be asynchronous if the `private_key' is + * accelerated private key. If this returns NULL the asynchronous + * operation cannot be controlled. + * + ***/ +SilcAsyncOperation silc_pkcs_sign(SilcPrivateKey private_key, + unsigned char *src, + SilcUInt32 src_len, + SilcBool compute_hash, + SilcHash hash, + SilcRng rng, + SilcPKCSSignCb sign_cb, + void *context); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_verify + * + * SYNOPSIS + * + * SilcAsyncOperation silc_pkcs_verify(SilcPublicKey public_key, + * unsigned char *signature, + * SilcUInt32 signature_len, + * unsigned char *data, + * SilcUInt32 data_len, + * SilcHash hash, + * SilcPKCSVerifyCb verify_cb, + * void *context); + * + * DESCRIPTION + * + * Verifies signature. The `verify_cb' will be called to deliver the + * result of the verification process. The 'signature' is verified against + * the 'data'. If the `hash' is non-NULL then the `data' will hashed + * before verification. If the `hash' is NULL, then the hash algorithm + * to be used is retrieved from the signature. If it isn't present in the + * signature the verification is done as is without hashing. The `rng' + * is usually not needed and may be NULL. If this returns NULL the + * asynchronous operation cannot be controlled. + * + ***/ +SilcAsyncOperation silc_pkcs_verify(SilcPublicKey public_key, + unsigned char *signature, + SilcUInt32 signature_len, + unsigned char *data, SilcUInt32 data_len, - unsigned char *passphrase, - SilcUInt32 encoding); -int silc_pkcs_load_public_key(char *filename, SilcPublicKey *public_key, - SilcUInt32 encoding); -int silc_pkcs_load_private_key(char *filename, SilcPrivateKey *private_key, - SilcUInt32 encoding); - -#endif + SilcHash hash, + SilcPKCSVerifyCb verify_cb, + void *context); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_load_public_key + * + * SYNOPSIS + * + * SilcBool silc_pkcs_load_public_key(const char *filename, + * SilcPKCSType type, + * SilcPublicKey *ret_public_key); + * + * DESCRIPTION + * + * Loads public key from file and allocates new public key. Returns TRUE + * if loading was successful. If `type' is SILC_PKSC_ANY this attempts + * to automatically detect the public key type. If `type' is some other + * PKCS type, the key is expected to be of that type. + * + ***/ +SilcBool silc_pkcs_load_public_key(const char *filename, + SilcPKCSType type, + SilcPublicKey *ret_public_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_save_public_key + * + * SYNOPSIS + * + * SilcBool silc_pkcs_save_public_key(const char *filename, + * SilcPublicKey public_key, + * SilcPKCSFileEncoding encoding); + * + * DESCRIPTION + * + * Saves public key into file with specified encoding. Returns FALSE + * on error. + * + ***/ +SilcBool silc_pkcs_save_public_key(const char *filename, + SilcPublicKey public_key, + SilcPKCSFileEncoding encoding); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_load_private_key + * + * SYNOPSIS + * + * SilcBool silc_pkcs_load_private_key(const char *filename, + * const unsigned char *passphrase, + * SilcUInt32 passphrase_len, + * SilcPKCSType type, + * SilcPrivateKey *ret_private_key); + * + * DESCRIPTION + * + * Loads private key from file and allocates new private key. Returns TRUE + * if loading was successful. The `passphrase' is used as decryption + * key of the private key file, in case it is encrypted. If `type' is + * SILC_PKSC_ANY this attempts to automatically detect the private key type. + * If `type' is some other PKCS type, the key is expected to be of that + * type. + * + ***/ +SilcBool silc_pkcs_load_private_key(const char *filename, + const unsigned char *passphrase, + SilcUInt32 passphrase_len, + SilcPKCSType type, + SilcPrivateKey *ret_private_key); + +/****f* silccrypt/SilcPKCSAPI/silc_pkcs_save_private_key + * + * SYNOPSIS + * + * SilcBool silc_pkcs_save_private_key(const char *filename, + * SilcPrivateKey private_key, + * const unsigned char *passphrase, + * SilcUInt32 passphrase_len, + * SilcPKCSFileEncoding encoding, + * SilcRng rng); + * + * DESCRIPTION + * + * Saves private key into file. The private key is encrypted into + * the file with the `passphrase' as a key, if PKCS supports encrypted + * private keys. Returns FALSE on error. + * + ***/ +SilcBool silc_pkcs_save_private_key(const char *filename, + SilcPrivateKey private_key, + const unsigned char *passphrase, + SilcUInt32 passphrase_len, + SilcPKCSFileEncoding encoding, + SilcRng rng); + +/****f* silccrypt/SilcPKCSAPI/silc_hash_public_key + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_public_key(void *key, void *user_context); + * + * DESCRIPTION + * + * An utility function for hashing public key for SilcHashTable. Give + * this as argument as the hash function for SilcHashTable. + * + ***/ +SilcUInt32 silc_hash_public_key(void *key, void *user_context); + +/****f* silccrypt/SilcPKCSAPI/silc_hash_public_key_compare + * + * SYNOPSIS + * + * SilcBool silc_hash_public_key_compare(void *key1, void *key2, + * void *user_context); + * + * DESCRIPTION + * + * An utility function for comparing public keys for SilcHashTable. Give + * this as argument as the compare function for SilcHashTable. + * + ***/ +SilcBool silc_hash_public_key_compare(void *key1, void *key2, + void *user_context); + +#endif /* !SILCPKCS_H */