RSA BSAFE Micro Edition Suite	Streamlined security for mobile and embedded devices

---

r_pkey.h

Go to the documentation of this file.

/* $Id: r_pkey.h,v 1.141.2.1 2005/10/12 04:15:57 hpriddle Exp $ */
/*
 * Copyright (C) 1998-2003 RSA Security Inc. All rights reserved.
 *
 * This work contains proprietary information of RSA Security.
 * Distribution is limited to authorized licensees of RSA
 * Security. Any unauthorized reproduction, distribution or
 * modification of this work is strictly prohibited.
 */

#ifndef HEADER_COMMON_CERT_R_PKEY_H
#define HEADER_COMMON_CERT_R_PKEY_H

#ifdef  __cplusplus
extern "C" {
#endif

#include "r_lib.h"
#include "r_types.h"
#include "pk_ids.h"
#include "r_pkey_err.h"
#include "r_format.h"

#ifndef NO_BIO
#include "bio.h"
#endif /* NO_BIO */

/* definitions from cryp_mod.h so that types match in R_PKEY_ALG_INFO */
#ifndef HEADER_COMMON_MODULE_CRYP_MOD_TYPEDEF_DEF
#define HEADER_COMMON_MODULE_CRYP_MOD_TYPEDEF_DEF
typedef int R_CR_ALG_ID;
typedef int R_CR_ALG_TYPE;
typedef int R_CR_ALG_SUB;
#endif /* HEADER_COMMON_MODULE_CRYP_MOD_TYPEDEF_DEF */

/*
 * Exported macro constants
 */

/*
 * There are definitions for a PKEY type used in R_PKEY_from_binary()
 * which are deliberately compatible with the defines used for the
 * @ref EVP_PKEY types in older implementations .
 *
 * That is the values are the same as @ref EVP_PKEY_RSA, @ref EVP_PKEY_DSA and
 * @ref EVP_PKEY_DH.
 *
 */

typedef int R_PKEY_TYPE;

#define R_PKEY_TYPE_UNKNOWN  -1

#define R_PKEY_TYPE_RSA       6

#define R_PKEY_TYPE_DH        28

#define R_PKEY_TYPE_DSA       116

#define R_PKEY_TYPE_DSAPARAMS  1001

#define R_PKEY_TYPE_ECC       178

/*
 * Defines for flags used in the _from_binary calls.
 *
 * NOTE: the flag values for both R_CERT and R_PKEY are the same.
 *
 */

#define R_PKEY_FL_DEFAULT          0x0000

#define R_PKEY_FL_COPY_DATA        0x0000

#define R_PKEY_FL_BY_REFERENCE     0x0001

typedef int R_PKEY_FORMAT;

#define R_PKEY_FORMAT_BINARY            R_FORMAT_BINARY

#define R_PKEY_FORMAT_PEM               R_FORMAT_PEM

#define R_PKEY_FORMAT_PKCS1             (0x0000 | R_FORMAT_BINARY)

#define R_PKEY_FORMAT_PKCS8             (0x0001 | R_FORMAT_BINARY)

/* Indicates that the #R_PKEY is in text format. */
#define R_PKEY_FORMAT_TEXT              R_FORMAT_TEXT

/* Indicates text output format. */
#define R_PKEY_PRINT_FORMAT_TEXT        R_FORMAT_TEXT

/* Indicates C code function format.  */
#define R_PKEY_PRINT_FORMAT_CODE_BINARY R_FORMAT_CODE_BINARY

/* Indicates C code fields format.  */
#define R_PKEY_PRINT_FORMAT_CODE_FIELDS R_FORMAT_CODE_FIELDS

/* Indicates C code data format. */
#define R_PKEY_PRINT_FORMAT_CODE_HEX    R_FORMAT_CODE_HEX

/* Indicates plain hexadecimal Bytes format. */
#define R_PKEY_PRINT_FORMAT_HEX         R_FORMAT_HEX

#define R_PKEY_FORMAT_PUBKEY_INFO       (0x0002 | R_FORMAT_BINARY)

#ifndef NO_PEM

/* supported PEM cipher strings for encrypted keys */

#define R_PKEY_PEM_CIPHER_DES           "DES-CBC"

#define R_PKEY_PEM_CIPHER_DES_EDE       "DES-EDE3-CBC"

/*
 * \ifnot MES
 * @}
 * \endif
 */
#endif /* NO_PEM */

/* ID values for R_PKEY_get_field - defines come from pk_ids.h */

#define R_PKEY_FIELD_ID_RSA_MOD         PK_RSA_N

#define R_PKEY_FIELD_ID_RSA_EXP         PK_RSA_E

#define R_PKEY_FIELD_ID_RSA_PRIV_EXP    PK_RSA_D

#define R_PKEY_FIELD_ID_RSA_PRIME_N(n)    PK_RSA_PRIME(n)

#define R_PKEY_FIELD_ID_RSA_EXP_N(n)    PK_RSA_EXP(n)

#define R_PKEY_FIELD_ID_RSA_INV_N(n)    PK_RSA_INV(n)

#define R_PKEY_FIELD_ID_RSA_SUBPRIME1_N(n) PK_RSA_SUBPRIME1(n)

#define R_PKEY_FIELD_ID_RSA_SUBPRIME2_N(n) PK_RSA_SUBPRIME2(n)

#define R_PKEY_FIELD_ID_RSA_Q           PK_RSA_Q

#define R_PKEY_FIELD_ID_RSA_DMQ1        PK_RSA_DMQ1

#define R_PKEY_FIELD_ID_RSA_Q1          PK_RSA_Q1

#define R_PKEY_FIELD_ID_RSA_Q2          PK_RSA_Q2

#define R_PKEY_FIELD_ID_RSA_P           PK_RSA_P

#define R_PKEY_FIELD_ID_RSA_DMP1        PK_RSA_DMP1

#define R_PKEY_FIELD_ID_RSA_IQMP        PK_RSA_IQMP

#define R_PKEY_FIELD_ID_RSA_P1          PK_RSA_P1

#define R_PKEY_FIELD_ID_RSA_P2          PK_RSA_P2

#define R_PKEY_FIELD_ID_DH_PRIME        PK_DH_PRIME

#define R_PKEY_FIELD_ID_DH_GENERATOR    PK_DH_GENERATOR

#define R_PKEY_FIELD_ID_DH_PUB_KEY      PK_DH_PUB_KEY

#define R_PKEY_FIELD_ID_DH_PRIV_KEY     PK_DH_PRIV_KEY

#define R_PKEY_FIELD_ID_DSA_PRIME       PK_DSA_P

#define R_PKEY_FIELD_ID_DSA_SUBPRIME    PK_DSA_Q

#define R_PKEY_FIELD_ID_DSA_BASE        PK_DSA_G

#define R_PKEY_FIELD_ID_DSA_PUB_KEY     PK_DSA_PUB_KEY

#define R_PKEY_FIELD_ID_DSA_PRIV_KEY    PK_DSA_PRIV_KEY

#define R_PKEY_FIELD_ID_DSA_SEED        PK_DSA_SEED

#define R_PKEY_FIELD_ID_DSA_COUNTER     PK_DSA_COUNTER

#define R_PKEY_FIELD_ID_DSA_H           PK_DSA_H


#define R_PKEY_FIELD_ID_ECC_OID          PK_ECC_OID
#define R_PKEY_FIELD_ID_ECC_PARAMS       PK_ECC_PARAMS
#define R_PKEY_FIELD_ID_ECC_PUB_KEY      PK_ECC_PUB_KEY

/* Indicates that the R_PKEY field has no type */
#define R_PKEY_FIELD_TYPE_NONE          0

/* Indicates that the R_PKEY field is an integer */
#define R_PKEY_FIELD_TYPE_INT           1

/* Indicates that the R_PKEY field is an R_ITEM */
#define R_PKEY_FIELD_TYPE_ITEM          2

#define R_PKEY_INFO_ID_BASE           2000

#define R_PKEY_INFO_ID_RSA_MOD        R_PKEY_FIELD_ID_RSA_MOD

#define R_PKEY_INFO_ID_RSA_EXP        R_PKEY_FIELD_ID_RSA_EXP

#define R_PKEY_INFO_ID_RSA_PRIV_EXP   R_PKEY_FIELD_ID_RSA_PRIV_EXP

#define R_PKEY_INFO_ID_RSA_PRIME_N(n) R_PKEY_FIELD_ID_RSA_PRIME_N(n)

#define R_PKEY_INFO_ID_RSA_EXP_N(n)   R_PKEY_FIELD_ID_RSA_EXP_N(n)

#define R_PKEY_INFO_ID_RSA_INV_N(n)   R_PKEY_FIELD_ID_RSA_INV_N(n)

#define R_PKEY_INFO_ID_RSA_Q          R_PKEY_FIELD_ID_RSA_Q

#define R_PKEY_INFO_ID_RSA_DMQ1       R_PKEY_FIELD_ID_RSA_DMQ1

#define R_PKEY_INFO_ID_RSA_X931_Q1    R_PKEY_FIELD_ID_RSA_Q1

#define R_PKEY_INFO_ID_RSA_X931_Q2    R_PKEY_FIELD_ID_RSA_Q2

#define R_PKEY_INFO_ID_RSA_P          R_PKEY_FIELD_ID_RSA_P

#define R_PKEY_INFO_ID_RSA_DMP1       R_PKEY_FIELD_ID_RSA_DMP1

#define R_PKEY_INFO_ID_RSA_IQMP       R_PKEY_FIELD_ID_RSA_IQMP

#define R_PKEY_INFO_ID_RSA_X931_P1    R_PKEY_FIELD_ID_RSA_P1

#define R_PKEY_INFO_ID_RSA_X931_P2    R_PKEY_FIELD_ID_RSA_P2

#define R_PKEY_INFO_ID_DH_PRIME       R_PKEY_FIELD_ID_DH_PRIME

#define R_PKEY_INFO_ID_DH_GENERATOR   R_PKEY_FIELD_ID_DH_GENERATOR

#define R_PKEY_INFO_ID_DH_PUB_KEY     R_PKEY_FIELD_ID_DH_PUB_KEY

#define R_PKEY_INFO_ID_DH_PRIV_KEY    R_PKEY_FIELD_ID_DH_PRIV_KEY

#define R_PKEY_INFO_ID_DSA_PRIME      R_PKEY_FIELD_ID_DSA_PRIME

#define R_PKEY_INFO_ID_DSA_SUBPRIME   R_PKEY_FIELD_ID_DSA_SUBPRIME

#define R_PKEY_INFO_ID_DSA_BASE       R_PKEY_FIELD_ID_DSA_BASE

#define R_PKEY_INFO_ID_DSA_PUB_KEY    R_PKEY_FIELD_ID_DSA_PUB_KEY

#define R_PKEY_INFO_ID_DSA_PRIV_KEY   R_PKEY_FIELD_ID_DSA_PRIV_KEY

#define R_PKEY_INFO_ID_DSA_SEED       R_PKEY_FIELD_ID_DSA_SEED

#define R_PKEY_INFO_ID_DSA_COUNTER    R_PKEY_FIELD_ID_DSA_COUNTER

#define R_PKEY_INFO_ID_DSA_H          R_PKEY_FIELD_ID_DSA_H

#define R_PKEY_INFO_ID_R_PKEY_CTX     (R_PKEY_INFO_ID_BASE+1)

#define R_PKEY_INFO_ID_R_EITEMS       (R_PKEY_INFO_ID_BASE+2)

#define R_PKEY_INFO_ID_FLAG           (R_PKEY_INFO_ID_BASE+3)

#define R_PKEY_INFO_ID_DATA           (R_PKEY_INFO_ID_BASE+4)

#define R_PKEY_INFO_ID_REFERENCE      (R_PKEY_INFO_ID_BASE+5)

#define R_PKEY_INFO_ID_TYPE           (R_PKEY_INFO_ID_BASE+6)

#define R_PKEY_INFO_ID_NUM_BITS       (R_PKEY_INFO_ID_BASE+7)

#define R_PKEY_INFO_ID_NUM_PRIMES     (R_PKEY_INFO_ID_BASE+8)

#define R_PKEY_INFO_ID_BY_ALG             PK_OBJECT_ID_BY_ALG

#define R_PKEY_INFO_ID_DELETE               PK_SHARED_ID_DELETE_ITEM

#define R_PKEY_INFO_ID_KEY_ID               PK_SHARED_ID_HW_ID

#define R_PKEY_INFO_ID_R_HW_OBJ_PUBLIC      PK_SHARED_ID_R_HW_OBJ_PUBLIC

#define R_PKEY_INFO_ID_HW_CLASS             PK_SHARED_ID_HW_CLASS

#define R_PKEY_INFO_ID_HW_SUBJECT           PK_SHARED_ID_SUBJECT

/*
 *  This identifier is used to locate export Key Encryption Key (KEK)
 *  authority in an #R_PKEY.
 *
 *  @see R_PKEY_get_info().
 */
#define R_PKEY_INFO_ID_KEY_WRAP             PK_SHARED_ID_KEY_WRAP

/*
 *  This identifier is used to locate import Key Encryption Key (KEK)
 *  authority in an #R_PKEY.
 *
 *  @see R_PKEY_get_info().
 */
#define R_PKEY_INFO_ID_KEY_UNWRAP           PK_SHARED_ID_KEY_UNWRAP

#define R_PKEY_INFO_ID_KEY_SENSITIVE        PK_SHARED_ID_SENSITIVE

#define R_PKEY_INFO_ID_IS_TOKEN             PK_SHARED_ID_IS_TOKEN

#define R_PKEY_INFO_ID_LABEL                PK_SHARED_ID_LABEL

/*
 *  This identifier is a handle for storing the key's extractable
 *  indicator. If the attribute is <tt>FALSE</tt> then the key
 *  cannot be wrapped.
 *
 *  @see R_PKEY_get_info().
 */
#define R_PKEY_INFO_ID_KEY_EXTRACTABLE      PK_SHARED_ID_EXTRACTABLE

#define R_PKEY_INFO_ID_ENCRYPT              PK_SHARED_ID_ENCRYPT

#define R_PKEY_INFO_ID_DECRYPT              PK_SHARED_ID_DECRYPT

#define R_PKEY_INFO_ID_VERIFY               PK_SHARED_ID_VERIFY

#define R_PKEY_INFO_ID_SIGN                 PK_SHARED_ID_SIGN

#define R_PKEY_INFO_ID_PRIVATE              PK_SHARED_ID_PRIVATE

#define R_PKEY_INFO_ID_MODIFIABLE           PK_SHARED_ID_MODIFIABLE

#define R_PKEY_INFO_ID_PURPOSE              PK_SHARED_ID_PURPOSE

#define R_PKEY_INFO_ID_HW_KEY_TYPE          PK_SHARED_ID_HW_KEY_TYPE

#define R_PKEY_INFO_ID_LOCATION             PK_SHARED_ID_LOCATION

#define R_PKEY_INFO_ID_R_HW_OBJ_PRIVATE     PK_SHARED_ID_R_HW_OBJ_PRIVATE

#define R_PK_SETUP_REC(type,obj) { (type), { sizeof(obj), ((void*)(obj)) } },

typedef struct r_pkey_setup_st
{
   int      type;
   R_ITEM object;

} R_PKEY_SETUP, *R_PKEY_SETUP_PTR;

/*
 * There are opaque data types for those things for which can
 * switch the implementation routines - hence they do not really have
 * a known type as this is able to be changed at runtime.
 *
 */
#ifndef HEADER_COMMON_R_PKEY_TYPEDEF_DEF
#define HEADER_COMMON_R_PKEY_TYPEDEF_DEF

typedef struct r_pkey_st R_PKEY;
#endif /* HEADER_COMMON_R_PKEY_TYPEDEF_DEF */

#ifndef HEADER_COMMON_DATA_R_EITEMS_TYPEDEF_DEF
#define HEADER_COMMON_DATA_R_EITEMS_TYPEDEF_DEF
typedef struct r_eitem_st R_EITEM;      /* Extended item structure. */
typedef struct r_eitems_st R_EITEMS;    /* Extended items structure. */
#endif /* HEADER_COMMON_DATA_R_EITEMS_TYPEDEF_DEF */

/*
 * There is a method table (which encapsulates the functions that implement
 * the handling of all public key related functions for a particular type).
 */
typedef struct r_pkey_method_st R_PKEY_METHOD;


/*
 * There is a context which holds a method and other information needed
 * for the runtime glue between routines.
 */
#ifndef HEADER_COMMON_R_PKEY_CTX_TYPEDEF_DEF
#define HEADER_COMMON_R_PKEY_CTX_TYPEDEF_DEF

typedef struct r_pkey_ctx_st R_PKEY_CTX;
#endif /* HEADER_COMMON_R_PKEY_CTX_TYPEDEF_DEF */

typedef struct r_pkey_alg_info_st
{
    R_CR_ALG_TYPE type;  
    R_CR_ALG_ID   id;    
    R_CR_ALG_SUB  sub;   
    R_PKEY *pkey; 
} R_PKEY_ALG_INFO;

#ifndef NO_HDW

#endif /* NO_HDW */

#define R_PKEY_PURPOSE_PRIVATE_KEY         1

#define R_PKEY_PURPOSE_PUBLIC_KEY          2

#define R_PKEY_PURPOSE_PARAMETERS          3

#include "r_pkey_m.h"

/*
 * Exported functions
 */

#define R_PKEY_CTX_INFO_ID_LIB_CTX               1

#define R_PKEY_CTX_INFO_ID_R_PKEY_METHOD         2

#define R_PKEY_CTX_INFO_ID_CRYPTO_CTX            3

#define R_PKEY_CTX_INFO_ID_FLAG                  4

#define R_PKEY_CTX_INFO_ID_DATA                  5

 typedef int R_PKEY_CB_T(void *arg, int type, R_ITEM *item);

#ifndef NO_R_PKEY_METH_TABLE
int R_CDECL R_PKEY_CTX_new(R_LIB_CTX *lib_ctx, R_RES_FLAG flag, R_PKEY_TYPE pkeytype,
    R_PKEY_CTX **pkey_ctx);
int R_CDECL R_PKEY_CTX_free(R_PKEY_CTX *ctx);

int R_CDECL R_PKEY_CTX_get_info(R_PKEY_CTX *pkey_ctx, int id, void *param);
int R_CDECL R_PKEY_CTX_set_info(R_PKEY_CTX *pkey_ctx, int id, void *param);

R_LIB_CTX * R_CDECL R_PKEY_CTX_get_LIB_CTX(R_PKEY_CTX *ctx);
#endif /* !defined(NO_R_PKEY_METH_TABLE) */

R_PKEY_METHOD * R_CDECL R_PKEY_pk_method(void *imp_data);

#ifndef NO_R_PKEY_METH_TABLE
R_PKEY_CTX * R_CDECL R_PKEY_get_PKEY_CTX(R_PKEY *pkey);

/* Return the "type" of a pkey - R_PKEY_TYPE_* */
int R_CDECL R_PKEY_get_type(R_PKEY *pkey);

/* Public/Private key functions */
int R_CDECL R_PKEY_new(R_PKEY_CTX *ctx, R_PKEY_TYPE pkeytype, R_PKEY **pkey);
int R_CDECL R_PKEY_free(R_PKEY *pkey);
int R_CDECL R_PKEY_copy(R_PKEY *new_pkey, R_PKEY *pkey, int flag);
int R_CDECL R_PKEY_dup(R_PKEY *pkey, int flag, R_PKEY **new_pkey);

int R_CDECL R_PKEY_from_binary(R_PKEY_CTX *pkey_ctx, int flag, R_PKEY_TYPE type,
    unsigned int max_buf_len, const unsigned char *buf,
    unsigned int *consumed_len, R_PKEY **pkey);
int R_CDECL R_PKEY_to_binary(R_PKEY *pkey, unsigned int max_buf_len, unsigned char *buf,
    unsigned int *consumed_len);
int R_CDECL R_PKEY_from_public_key_binary(R_PKEY_CTX *pkey_ctx, int flag,
    R_PKEY_TYPE type, unsigned int max_buf_len, const unsigned char *buf,
    unsigned int *consumed_len, R_PKEY **pkey);
int R_CDECL R_PKEY_to_public_key_binary(R_PKEY *pkey, unsigned int max_buf_len,
    unsigned char *buf, unsigned int *out_len);

int R_CDECL R_PKEY_reference_inc(R_PKEY *pkey);
int R_CDECL R_PKEY_cmp(R_PKEY *key1, R_PKEY *key2);
int R_CDECL R_PKEY_public_cmp(R_PKEY *key1, R_PKEY *key2);

int R_CDECL R_PKEY_get_info(R_PKEY *pkey, int id, void *param);
int R_CDECL R_PKEY_set_info(R_PKEY *pkey, int type, void *param);

int R_CDECL R_PKEY_iterate_fields(R_PKEY *pkey, R_PKEY_CB_T *func, void *arg);

/* Crypto-related functions */
int R_CDECL R_PKEY_get_num_bits(R_PKEY *pkey);
int R_CDECL R_PKEY_get_num_primes(R_PKEY *pkey);
int R_CDECL R_PKEY_signhash(R_PKEY *pkey, unsigned char *data, unsigned int dlen,
    unsigned char *out, unsigned int *olen);
int R_CDECL R_PKEY_verifyhash(R_PKEY *pkey, unsigned char *data, unsigned int dlen,
    unsigned char *hash, unsigned int hlen);
#endif /* !defined(NO_R_PKEY_METH_TABLE) */

int R_CDECL R_PKEY_generate_simple(R_PKEY_CTX *pkey_ctx, R_PKEY **rpkey, int type,
    int num_bits, int modifier, int flags, R_SURRENDER *surrender);

/* wrapper functions - common non-format specific functions that simply
 * encapsulate often used steps
 */

int R_CDECL R_PKEY_public_from_file(R_PKEY_CTX *pkey_ctx, R_PKEY **pkey,
    char *filename, int type, R_FORMAT format);

int R_CDECL R_PKEY_from_file(R_PKEY_CTX *pkey_ctx, R_PKEY **pkey,
    char *filename, int type, R_FORMAT format);

int R_CDECL R_PKEY_TYPE_to_string(R_PKEY_TYPE type, unsigned int max_str_len,
    char *str);
int R_CDECL R_PKEY_TYPE_from_string(R_PKEY_TYPE *type, char *str);
int R_CDECL R_PKEY_TYPE_to_PEM_header(R_PKEY_TYPE type, unsigned int max_str_len, char *str);
int R_CDECL R_PKEY_TYPE_public_to_PEM_header(R_PKEY_TYPE type, unsigned int max_str_len, char *str);

int R_CDECL R_PKEY_FORMAT_to_string(R_PKEY_FORMAT format, unsigned int max_str_len,
    char *str);
int R_CDECL R_PKEY_FORMAT_from_string(char *str, R_PKEY_FORMAT *format);

#ifndef NO_BIO
int R_CDECL R_PKEY_to_bio(BIO *bio, R_PKEY *pkey, R_FORMAT format, char *cipher);

#ifndef NO_R_PKEY_METH_TABLE
int R_CDECL R_PKEY_print(BIO *bio, R_PKEY *pkey, R_FORMAT format, char *format_arg);
#endif /* !defined(NO_R_PKEY_METH_TABLE) */

int R_CDECL R_PKEY_from_bio(BIO *bio, R_PKEY_CTX *pkey_ctx, R_PKEY **pkey, int type, R_FORMAT format);

int R_CDECL R_PKEY_public_from_bio(BIO *bio, R_PKEY_CTX *pkey_ctx, R_PKEY **pkey, int type, R_FORMAT format);

/* R_PKEY print function to add into the resource list */
typedef int (R_CDECL R_PKEY_PRINT_FUNC_T)(BIO *bio, R_PKEY *pkey, R_FORMAT format,
    char *format_arg);

R_PKEY_PRINT_FUNC_T * R_CDECL R_PKEY_get_print_func(void *imp_data);

#else /* NO_BIO */

int R_CDECL R_PKEY_print(FILE *bio, R_PKEY *pkey, R_FORMAT format, char *format_arg);

#endif /* NO_BIO */


#ifdef  __cplusplus
}
#endif
#endif /* HEADER_COMMON_CERT_R_PKEY_H */

---

Copyright (c) 1999-2005 RSA Security Inc. All rights reserved. 072-001001-2100-001-000 - 2.1