x509.h

Go to the documentation of this file.

 
#ifndef POLARSSL_X509_H
#define POLARSSL_X509_H
 
#if !defined(POLARSSL_CONFIG_FILE)
#include "config.h"
#else
#include POLARSSL_CONFIG_FILE
#endif
 
#include "asn1.h"
#include "pk.h"
 
#if defined(POLARSSL_RSA_C)
#include "rsa.h"
#endif
 
#define POLARSSL_ERR_X509_FEATURE_UNAVAILABLE              -0x2080  
#define POLARSSL_ERR_X509_UNKNOWN_OID                      -0x2100  
#define POLARSSL_ERR_X509_INVALID_FORMAT                   -0x2180  
#define POLARSSL_ERR_X509_INVALID_VERSION                  -0x2200  
#define POLARSSL_ERR_X509_INVALID_SERIAL                   -0x2280  
#define POLARSSL_ERR_X509_INVALID_ALG                      -0x2300  
#define POLARSSL_ERR_X509_INVALID_NAME                     -0x2380  
#define POLARSSL_ERR_X509_INVALID_DATE                     -0x2400  
#define POLARSSL_ERR_X509_INVALID_SIGNATURE                -0x2480  
#define POLARSSL_ERR_X509_INVALID_EXTENSIONS               -0x2500  
#define POLARSSL_ERR_X509_UNKNOWN_VERSION                  -0x2580  
#define POLARSSL_ERR_X509_UNKNOWN_SIG_ALG                  -0x2600  
#define POLARSSL_ERR_X509_SIG_MISMATCH                     -0x2680  
#define POLARSSL_ERR_X509_CERT_VERIFY_FAILED               -0x2700  
#define POLARSSL_ERR_X509_CERT_UNKNOWN_FORMAT              -0x2780  
#define POLARSSL_ERR_X509_BAD_INPUT_DATA                   -0x2800  
#define POLARSSL_ERR_X509_MALLOC_FAILED                    -0x2880  
#define POLARSSL_ERR_X509_FILE_IO_ERROR                    -0x2900  
/* \} name */
 
#define BADCERT_EXPIRED             0x01  
#define BADCERT_REVOKED             0x02  
#define BADCERT_CN_MISMATCH         0x04  
#define BADCERT_NOT_TRUSTED         0x08  
#define BADCRL_NOT_TRUSTED          0x10  
#define BADCRL_EXPIRED              0x20  
#define BADCERT_MISSING             0x40  
#define BADCERT_SKIP_VERIFY         0x80  
#define BADCERT_OTHER             0x0100  
#define BADCERT_FUTURE            0x0200  
#define BADCRL_FUTURE             0x0400  
/* \} name */
/* \} addtogroup x509_module */
 
/*
 * X.509 v3 Key Usage Extension flags
 */
#define KU_DIGITAL_SIGNATURE            (0x80)  /* bit 0 */
#define KU_NON_REPUDIATION              (0x40)  /* bit 1 */
#define KU_KEY_ENCIPHERMENT             (0x20)  /* bit 2 */
#define KU_DATA_ENCIPHERMENT            (0x10)  /* bit 3 */
#define KU_KEY_AGREEMENT                (0x08)  /* bit 4 */
#define KU_KEY_CERT_SIGN                (0x04)  /* bit 5 */
#define KU_CRL_SIGN                     (0x02)  /* bit 6 */
 
/*
 * Netscape certificate types
 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
 */
 
#define NS_CERT_TYPE_SSL_CLIENT         (0x80)  /* bit 0 */
#define NS_CERT_TYPE_SSL_SERVER         (0x40)  /* bit 1 */
#define NS_CERT_TYPE_EMAIL              (0x20)  /* bit 2 */
#define NS_CERT_TYPE_OBJECT_SIGNING     (0x10)  /* bit 3 */
#define NS_CERT_TYPE_RESERVED           (0x08)  /* bit 4 */
#define NS_CERT_TYPE_SSL_CA             (0x04)  /* bit 5 */
#define NS_CERT_TYPE_EMAIL_CA           (0x02)  /* bit 6 */
#define NS_CERT_TYPE_OBJECT_SIGNING_CA  (0x01)  /* bit 7 */
 
/*
 * X.509 extension types
 *
 * Comments refer to the status for using certificates. Status can be
 * different for writing certificates or reading CRLs or CSRs.
 */
#define EXT_AUTHORITY_KEY_IDENTIFIER    (1 << 0)
#define EXT_SUBJECT_KEY_IDENTIFIER      (1 << 1)
#define EXT_KEY_USAGE                   (1 << 2)    /* Parsed but not used */
#define EXT_CERTIFICATE_POLICIES        (1 << 3)
#define EXT_POLICY_MAPPINGS             (1 << 4)
#define EXT_SUBJECT_ALT_NAME            (1 << 5)    /* Supported (DNS) */
#define EXT_ISSUER_ALT_NAME             (1 << 6)
#define EXT_SUBJECT_DIRECTORY_ATTRS     (1 << 7)
#define EXT_BASIC_CONSTRAINTS           (1 << 8)    /* Supported */
#define EXT_NAME_CONSTRAINTS            (1 << 9)
#define EXT_POLICY_CONSTRAINTS          (1 << 10)
#define EXT_EXTENDED_KEY_USAGE          (1 << 11)   /* Parsed but not used */
#define EXT_CRL_DISTRIBUTION_POINTS     (1 << 12)
#define EXT_INIHIBIT_ANYPOLICY          (1 << 13)
#define EXT_FRESHEST_CRL                (1 << 14)
 
#define EXT_NS_CERT_TYPE                (1 << 16)   /* Parsed (and then ?) */
 
/*
 * Storage format identifiers
 * Recognized formats: PEM and DER
 */
#define X509_FORMAT_DER                 1
#define X509_FORMAT_PEM                 2
 
#define X509_MAX_DN_NAME_SIZE         256 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef asn1_buf x509_buf;
 
typedef asn1_bitstring x509_bitstring;
 
typedef asn1_named_data x509_name;
 
typedef asn1_sequence x509_sequence;
 
typedef struct _x509_time
{
    int year, mon, day;         
    int hour, min, sec;         
}
x509_time;
 
int x509_dn_gets( char *buf, size_t size, const x509_name *dn );
 
int x509_serial_gets( char *buf, size_t size, const x509_buf *serial );
 
const char *x509_oid_get_description( x509_buf *oid );
 
int x509_oid_get_numeric_string( char *buf, size_t size, x509_buf *oid );
 
int x509_time_expired( const x509_time *time );
 
int x509_time_future( const x509_time *time );
 
int x509_self_test( int verbose );
 
/*
 * Internal module functions. You probably do not want to use these unless you
 * know you do.
 */
int x509_get_name( unsigned char **p, const unsigned char *end,
                   x509_name *cur );
int x509_get_alg_null( unsigned char **p, const unsigned char *end,
                       x509_buf *alg );
int x509_get_alg( unsigned char **p, const unsigned char *end,
                  x509_buf *alg, x509_buf *params );
#if defined(POLARSSL_X509_RSASSA_PSS_SUPPORT)
int x509_get_rsassa_pss_params( const x509_buf *params,
                                md_type_t *md_alg, md_type_t *mgf_md,
                                int *salt_len );
#endif
int x509_get_sig( unsigned char **p, const unsigned char *end, x509_buf *sig );
int x509_get_sig_alg( const x509_buf *sig_oid, const x509_buf *sig_params,
                      md_type_t *md_alg, pk_type_t *pk_alg,
                      void **sig_opts );
int x509_get_time( unsigned char **p, const unsigned char *end,
                   x509_time *time );
int x509_get_serial( unsigned char **p, const unsigned char *end,
                     x509_buf *serial );
int x509_get_ext( unsigned char **p, const unsigned char *end,
                  x509_buf *ext, int tag );
int x509_load_file( const char *path, unsigned char **buf, size_t *n );
int x509_sig_alg_gets( char *buf, size_t size, const x509_buf *sig_oid,
                       pk_type_t pk_alg, md_type_t md_alg,
                       const void *sig_opts );
int x509_key_size_helper( char *buf, size_t size, const char *name );
int x509_string_to_names( asn1_named_data **head, const char *name );
int x509_set_extension( asn1_named_data **head, const char *oid, size_t oid_len,
                        int critical, const unsigned char *val,
                        size_t val_len );
int x509_write_extensions( unsigned char **p, unsigned char *start,
                           asn1_named_data *first );
int x509_write_names( unsigned char **p, unsigned char *start,
                      asn1_named_data *first );
int x509_write_sig( unsigned char **p, unsigned char *start,
                    const char *oid, size_t oid_len,
                    unsigned char *sig, size_t size );
 
#ifdef __cplusplus
}
#endif
 
#endif /* x509.h */