lib/hx509/hx509.h

   1 /*
   2  * Copyright (c) 2004 - 2007 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef HEIMDAL_HX509_H
  37 #define HEIMDAL_HX509_H 1
  38
  39 #include <heim_asn1.h>
  40 #include <rfc2459_asn1.h>
  41
  42 typedef struct hx509_cert_attribute_data *hx509_cert_attribute;
  43 typedef struct hx509_cert_data *hx509_cert;
  44 typedef struct hx509_certs_data *hx509_certs;
  45 typedef struct hx509_context_data *hx509_context;
  46 typedef struct hx509_crypto_data *hx509_crypto;
  47 typedef struct hx509_lock_data *hx509_lock;
  48 typedef struct hx509_name_data *hx509_name;
  49 typedef struct hx509_private_key *hx509_private_key;
  50 typedef struct hx509_validate_ctx_data *hx509_validate_ctx;
  51 typedef struct hx509_verify_ctx_data *hx509_verify_ctx;
  52 typedef struct hx509_revoke_ctx_data *hx509_revoke_ctx;
  53 typedef struct hx509_query_data hx509_query;
  54 typedef void * hx509_cursor;
  55 typedef struct hx509_request_data *hx509_request;
  56 typedef struct hx509_error_data *hx509_error;
  57 typedef struct hx509_peer_info *hx509_peer_info;
  58 typedef struct hx509_ca_tbs *hx509_ca_tbs;
  59 typedef struct hx509_env_data *hx509_env;
  60 typedef struct hx509_crl *hx509_crl;
  61
  62 typedef void (*hx509_vprint_func)(void *, const char *, va_list);
  63
  64 enum {
  65     HX509_VHN_F_ALLOW_NO_MATCH = 1
  66 };
  67
  68 enum {
  69     HX509_VALIDATE_F_VALIDATE = 1,
  70     HX509_VALIDATE_F_VERBOSE = 2
  71 };
  72
  73 struct hx509_cert_attribute_data {
  74     heim_oid oid;
  75     heim_octet_string data;
  76 };
  77
  78 typedef enum {
  79     HX509_PROMPT_TYPE_PASSWORD          = 0x1,  /* password, hidden */
  80     HX509_PROMPT_TYPE_QUESTION          = 0x2,  /* question, not hidden */
  81     HX509_PROMPT_TYPE_INFO              = 0x4   /* infomation, reply doesn't matter */
  82 } hx509_prompt_type;
  83
  84 typedef struct hx509_prompt {
  85     const char *prompt;
  86     hx509_prompt_type type;
  87     heim_octet_string reply;
  88 } hx509_prompt;
  89
  90 typedef int (*hx509_prompter_fct)(void *, const hx509_prompt *);
  91
  92 typedef struct hx509_octet_string_list {
  93     size_t len;
  94     heim_octet_string *val;
  95 } hx509_octet_string_list;
  96
  97 typedef struct hx509_pem_header {
  98     struct hx509_pem_header *next;
  99     char *header;
 100     char *value;
 101 } hx509_pem_header;
 102
 103 typedef int
 104 (*hx509_pem_read_func)(hx509_context, const char *, const hx509_pem_header *,
 105                        const void *, size_t, void *ctx);
 106
 107 /*
 108  * Options passed to hx509_query_match_option.
 109  */
 110 typedef enum {
 111     HX509_QUERY_OPTION_PRIVATE_KEY = 1,
 112     HX509_QUERY_OPTION_KU_ENCIPHERMENT = 2,
 113     HX509_QUERY_OPTION_KU_DIGITALSIGNATURE = 3,
 114     HX509_QUERY_OPTION_KU_KEYCERTSIGN = 4,
 115     HX509_QUERY_OPTION_END = 0xffff
 116 } hx509_query_option;
 117
 118 /* flags to hx509_certs_init */
 119 #define HX509_CERTS_CREATE                              0x01
 120 #define HX509_CERTS_UNPROTECT_ALL                       0x02
 121
 122 /* flags to hx509_set_error_string */
 123 #define HX509_ERROR_APPEND                              0x01
 124
 125 /* flags to hx509_cms_unenvelope */
 126 #define HX509_CMS_UE_DONT_REQUIRE_KU_ENCIPHERMENT       0x01
 127
 128 /* selectors passed to hx509_crypto_select and hx509_crypto_available */
 129 #define HX509_SELECT_ALL 0
 130 #define HX509_SELECT_DIGEST 1
 131 #define HX509_SELECT_PUBLIC_SIG 2
 132 #define HX509_SELECT_PUBLIC_ENC 3
 133 #define HX509_SELECT_SECRET_ENC 4
 134
 135 /* flags to hx509_ca_tbs_set_template */
 136 #define HX509_CA_TEMPLATE_SUBJECT 1
 137 #define HX509_CA_TEMPLATE_SERIAL 2
 138 #define HX509_CA_TEMPLATE_NOTBEFORE 4
 139 #define HX509_CA_TEMPLATE_NOTAFTER 8
 140 #define HX509_CA_TEMPLATE_SPKI 16
 141 #define HX509_CA_TEMPLATE_KU 32
 142 #define HX509_CA_TEMPLATE_EKU 64
 143
 144 /* flags hx509_cms_create_signed* */
 145 #define HX509_CMS_SIGATURE_DETACHED 1
 146 #define HX509_CMS_SIGATURE_ID_NAME 2
 147
 148 /* hx509_verify_hostname nametype */
 149 typedef enum  {
 150     HX509_HN_HOSTNAME = 0,
 151     HX509_HN_DNSSRV
 152 } hx509_hostname_type;
 153
 154 #include <hx509-protos.h>
 155 #include <hx509_err.h>
 156
 157 #endif /* HEIMDAL_HX509_H */