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

---

cert_sm.h

Go to the documentation of this file.

/* $Id: cert_sm.h,v 1.97.4.3 2005/10/12 05:45:47 hpriddle Exp $ */
/*
 * Copyright (C) 2001-2002 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_CERT_SM_H
#define HEADER_CERT_SM_H

#ifdef  __cplusplus
extern "C" {
#endif

/*
 * Include files
 */

#include "stack.h"
#ifndef NO_PEM
#include "pem.h"
#endif
#include "x509tc.h"

#ifdef INCLUDE_MHP_SSLSIGN_API
#include "sslsign.h"
#endif

/*
 * Exported macro constants
 */

/*
 * numeric identifiers for public key types that may be used for signing.
 * we need to have a definition for a PKEY type for SSLCERT_PKEY_from_binary
 * These values could be returned by SSLCERT_get_signature_type.
 */
#ifndef EVP_PKEY_RSA
#define EVP_PKEY_RSA     6
#endif

#ifndef EVP_PKEY_DSA
#define EVP_PKEY_DSA     116
#endif

/* These values could be returned by SSLCERT_get_signature_digest_type
 * NOTE: These *must* be the same values as the X509_DIGEST_TYPE_* defines
 * in xtc_locl.h
 */
#define SSLCERT_DIGEST_TYPE_MD2            1

#define SSLCERT_DIGEST_TYPE_MD5            2

#define SSLCERT_DIGEST_TYPE_SHA1           3

#define  SSLCERT_TIME_NOTBEFORE      TC_X509_TIME_NOTBEFORE

#define  SSLCERT_TIME_NOTAFTER       TC_X509_TIME_NOTAFTER
/* END: SSLCERT_VALIDITY_TIME_IDS */
/*
 * Exported types
 */

/* make sure we have a definition (safe) for EVP_PKEY and EVP_MD */
#if !defined(HEADER_COMMON_EVP_H) && !defined(HEADER_SSL_H)
#ifndef HEADER_COMMON_EVP_H_TYPEDEF_DEF
#define HEADER_COMMON_EVP_H_TYPEDEF_DEF
typedef struct evp_pkey_st EVP_PKEY; /* EVP asymmetric key type */
typedef struct evp_md_st EVP_MD;    /* EVP message digest type */
typedef struct evp_md_ctx_st EVP_MD_CTX; /* EVP message digest ctx type */
typedef struct evp_cipher_st EVP_CIPHER; /* EVP cipher type */
typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX; /* EVP cipher ctx type */
typedef struct evp_encode_ctx_st EVP_ENCODE_CTX; /* EVP Base64 ctx type */
/* To remove a dependence of the old evp on ASN.1 definitions */
typedef void EVP_ASN1_TYPE;    /* EVP general ASN.1 object type */
#endif /* HEADER_COMMON_EVP_H_TYPEDEF_DEF */
#endif /* !defined(HEADER_COMMON_EVP_H) && !defined(HEADER_SSL_H) */

/* we declare opaque data types for those things for which we can
 * switch the implementation routines - hence they do not really have
 * a known type as it can change at runtime
 */

typedef TC_X509 SSLCERT;            /* X509 certificate type */

typedef TC_X509_NAME SSLCERT_NAME;  /* X509 NAME type */

typedef TC_X509_NAME_ENTRY SSLCERT_NAME_ENTRY; /* X509 NAME_ENTRY type */

typedef EVP_PKEY SSLCERT_PKEY;      /* Asymmetric key type */

typedef void SSLCERT_STORE_CTX;     /* Certificate store instance type */

typedef void SSLCERT_STORE;         /* Certificate store type */

/* Some functions from EVP layer are public APIs */
void R_CDECL EVP_PKEY_free(EVP_PKEY *pkey);
void R_CDECL EVP_PKEY_reference_inc(EVP_PKEY *pkey);
EVP_PKEY * R_CDECL EVP_PKEY_new(void);

/* make sure we have a definition (safe) for SSL */
#ifndef HEADER_SSL_H_TYPEDEF_DEF
#define HEADER_SSL_H_TYPEDEF_DEF
typedef struct ssl_st SSL;           /* SSL structure type */
#endif /* HEADER_SSL_H_TYPEDEF_DEF*/

/*
 * Exported macro functions
 */

/* Much of the SSLCERT API for a SSL-C small code build is defined to
 * call directly to TC_X509 functions for certificate handling. Because
 * this implementation is limited some of the API macros are undefined.
 * The list follows:
 *   void *SSLCERT_from_binary_bio(BIO *bio, SSLCERT *cert),
 *   SSLCERT_STORE_new(),               SSLCERT_STORE_free(),
 *   SSLCERT_STORE_load_locations(),    SSLCERT_STORE_set_default_paths(s),
 *   SSLCERT_STORE_set_verify_cb(s,cb),SSLCERT_STORE_get_by_subject(sc,t,n,r),
 *   SSLCERT_STORE_CTX_new(),           SSLCERT_STORE_CTX_free(sc),
 *   SSLCERT_STORE_CTX_init(sc,s,c,ch), SSLCERT_STORE_CTX_cleanup(sc),
 *   SSLCERT_STORE_get_ex_new_index(l,p,nf,df,ff),
 *   SSLCERT_STORE_cleanup_ex_data(),   SSLCERT_STORE_set_ex_data(c,i,d),
 *   SSLCERT_STORE_get_ex_data(sc,i),   SSLCERT_STORE_CTX_get_error(sc),
 *   SSLCERT_STORE_CTX_set_error(sc,err),
 *   SSLCERT_STORE_CTX_get_error_depth(sc),
 *   SSLCERT_STORE_CTX_get_current_cert(sc)
 *
 */

#define SSLCERT_tinycode_setup()


#define SSLCERT_normal_setup()

#define SSLCERT_new          TC_X509_new

#define SSLCERT_free         TC_X509_free

#define SSLCERT_set_meth_data TC_X509_set_meth_data

#define SSLCERT_get_meth_data TC_X509_get_meth_data

#define SSLCERT_set_info TC_X509_set_info

#define SSLCERT_get_info TC_X509_get_info

#define SSLCERT_dup TC_X509_dup

#define SSLCERT_verify       TC_X509_verify

#define SSLCERT_digest       TC_X509_digest

#define SSLCERT_to_binary    i2d_TC_X509

#define SSLCERT_from_binary  d2i_TC_X509

#define SSLCERT_reference_inc      TC_X509_reference_inc

#define SSLCERT_get_signature_type TC_X509_get_signature_type

#define SSLCERT_get_signature_digest_type TC_X509_get_signature_digest_type

#define SSLCERT_get_signature_data(cert,len,data) \
    TC_X509_get_signature_data((cert),(len),(data))

#define SSLCERT_get_version TC_X509_get_version

#define SSLCERT_get_version_string TC_X509_get_version_string

#define SSLCERT_subject_name_cmp   TC_X509_subject_name_cmp

#define SSLCERT_get_issuer_name    TC_X509_get_issuer_name

#define SSLCERT_get_subject_name   TC_X509_get_subject_name

#define SSLCERT_get_pubkey         TC_X509_get_pubkey

#define SSLCERT_get_pubkey_info(cert,pp,length) \
    TC_X509_get_pubkey_info_data((cert),(pp),(length))

#define SSLCERT_check_private_key  TC_X509_check_private_key

#define SSLCERT_do_application_cb(s,sk,cb,cbarg,vr) \
  ((cb) != NULL)?((cb)((s),(SSLCERT **)(sk_data(sk)),\
                        sk_num((sk)),(cbarg),(vr))):0

#define SSLCERT_do_verify_cb(s,sk,sc,cb,cbarg,vr) \
        ((*(vr)=X509_V_ERR_APPLICATION_VERIFICATION), 0)

#define SSLCERT_NAME_new    TC_X509_NAME_new

#define SSLCERT_NAME_free   TC_X509_NAME_free

#define SSLCERT_NAME_dup   TC_X509_NAME_dup

#define SSLCERT_NAME_hash   TC_X509_NAME_hash

#define SSLCERT_NAME_cmp    TC_X509_NAME_cmp

#define SSLCERT_NAME_from_binary        d2i_TC_X509_NAME

#define SSLCERT_NAME_to_binary          i2d_TC_X509_NAME

#define SSLCERT_NAME_oneline   TC_X509_NAME_oneline

#define SSLCERT_NAME_get_entry_count    TC_X509_NAME_get_entry_count

#define SSLCERT_NAME_get_entry          TC_X509_NAME_get_entry

#define SSLCERT_NAME_ENTRY_get_oid_info(cne,oidtype,oidpp,oidlen) \
        SSLCERT_NAME_ENTRY_get_info \
                             ((cne),(oidtype),(oidpp),(oidlen),NULL,NULL,NULL)

#define SSLCERT_NAME_ENTRY_get_data_info(cne,datatype,datapp,datalen) \
        SSLCERT_NAME_ENTRY_get_info \
                          ((cne),NULL,NULL,NULL,(datatype),(datapp),(datalen))


#ifndef NO_PEM

#define SSLCERT_PEM_read_bio_SSLCERT(bp,c,cb) \
    PEM_ASN1_read_bio((char *(*)())d2i_TC_X509,PEM_STRING_X509,(bp),(c),cb)

#endif /* NO_PEM */

#define SSLCERT_PKEY_new      EVP_PKEY_new

#define SSLCERT_PKEY_free     EVP_PKEY_free

#define SSLCERT_PKEY_from_PUBKEY_binary(type,ppkey,pp,length) \
    d2i_TC_PublicKey((type),(ppkey),(pp),(length))

#define SSLCERT_verify_signature        TC_X509_verify_signature

#define SSLCERT_PKEY_reference_inc   EVP_PKEY_reference_inc

#define SSLCERT_PKEY_from_binary(type,ppkey,pp,length) \
    d2i_TC_PrivateKey((type),(ppkey),(pp),(length))

#define SSLCERT_PKEY_to_binary(ppkey,pp) \
    i2d_TC_PrivateKey((ppkey),(pp))

#define SSLCERT_PKEY_to_PUBKEY_binary(ppkey,pp) \
    i2d_TC_PublicKey((ppkey),(pp))

#define SSLCERT_verify_signature        TC_X509_verify_signature

#define SSLCERT_get_serialNumber_info(cert,type,pp,length) \
    TC_X509_get_serialNumber_info((cert),(type),(pp),(length))

#define SSLCERT_get_serialNumber_int(cert,snump) \
    TC_X509_get_serialNumber_int((cert),(snump))

#define SSLCERT_get_notAfter(cert,type,pp,length) \
    TC_X509_get_notAfter_info((cert),(type),(pp),(length))

#define SSLCERT_get_notBefore(cert,type,pp,length) \
    TC_X509_get_notBefore_info((cert),(type),(pp),(length))

#define SSLCERT_NAME_get_info(xn,pp,length) \
    TC_X509_NAME_get_info_data((xn),(pp),(length))

#define SSLCERT_NAME_ENTRY_get_info(cne,oidtype,oidpp,oidlen,datatype,datapp, \
                                    datalen) \
    TC_X509_NAME_ENTRY_get_info_data((cne),(oidtype),(oidpp),(oidlen), \
                                     (datatype),(datapp),(datalen))

#define SSLCERT_get_TBSCertificate_data(cert,len,data) \
    TC_X509_get_TBSCertificate_data((cert),(len),(data))

#define SSLCERT_get_validity_seconds(cert,id,pseconds) \
    TC_X509_get_validity_seconds((cert),(id),(pseconds))

#define SSLCERT_get_basic_constraints_int(cert,crit,constraints,is_ca) \
    TC_X509_get_basic_constraints_int(cert,crit,constraints,is_ca)

#define SSLCERT_get_key_usage_int(cert,crit,usage) \
    TC_X509_get_key_usage_int(cert,crit,usage)

#define SSLCERT_get_crl_distribution_points(cert,index,what,crit,len,data) \
    TC_X509_get_crl_distribution_points(cert,index,what,crit,len,data)

/*
 * Function prototypes
 */

char * R_CDECL SSLCERT_OID_to_string(unsigned char *data,long len,int flag);
int R_CDECL SSLCERT_fingerprint(SSLCERT *cert,unsigned char *buf,unsigned int *plen);
int R_CDECL SSLCERT_compare_ASN1_time(int time_encoding, unsigned char *cert_time,
    unsigned int now_time, int *result);

/*
 * These macros are defined to be backward compatibile with  SSL-C ME 1.0.1
 */
#define SSLCERT_get_cRLDistributionPoints \
    SSLCERT_get_crl_distribution_points

#define SSLCERT_get_key_Usage_int SSLCERT_get_key_usage_int

/* end group SSL_CERT_HAND_FUNCS */
void R_CDECL ERR_load_SSLCERT_strings(void);



/* BEGIN ERROR CODES */
/* Error codes for the SSLCERT functions. */

/* Function codes. */
#define SSLCERT_F_FINGERPRINT                 101
#define SSLCERT_F_FROM_BINARY_BIO             113
#define SSLCERT_F_GET_VERSION                 154
#define SSLCERT_F_PKEY_FROM_BINARY            107
#define SSLCERT_F_STORE_CTX_CLEANUP           137
#define SSLCERT_F_STORE_CTX_CLEANUP_EX_DATA   138
#define SSLCERT_F_STORE_CTX_FREE              152
#define SSLCERT_F_STORE_CTX_GET_CURRENT_CERT  139
#define SSLCERT_F_STORE_CTX_GET_ERROR         140
#define SSLCERT_F_STORE_CTX_GET_ERROR_DEPTH   141
#define SSLCERT_F_STORE_CTX_GET_EX_DATA       142
#define SSLCERT_F_STORE_CTX_GET_EX_NEW_INDEX  102
#define SSLCERT_F_STORE_CTX_INIT              143
#define SSLCERT_F_STORE_CTX_NEW               153
#define SSLCERT_F_STORE_CTX_SET_ERROR         144
#define SSLCERT_F_STORE_CTX_SET_EX_DATA       145
#define SSLCERT_F_STORE_GET_BY_SUBJECT        147
#define SSLCERT_F_STORE_LOAD_LOCATIONS        103
#define SSLCERT_F_STORE_SET_DEFAULT_PATHS     104
#define SSLCERT_F_STORE_SET_VERIFY_CB         155
#define SSLCERT_F_PKEY_TO_BINARY              174
#define SSLCERT_F_PKEY_TO_PUBKEY_BINARY       175

/* Reason codes. */

#ifdef  __cplusplus
}
#endif

#endif /* HEADER_CERT_SM_H */

---

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