[thirdparty/openssl.git] / crypto / asn1 / asn1_locl.h

/* asn1t.h */
/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
 * project 2006.
 */
/* ====================================================================
 * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    licensing@OpenSSL.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh@cryptsoft.com).
 *
 */

/* Internal ASN1 structures and functions: not for application use */

int asn1_utctime_to_tm(struct tm *tm, const ASN1_UTCTIME *d);
int asn1_generalizedtime_to_tm(struct tm *tm, const ASN1_GENERALIZEDTIME *d);

/* ASN1 print context structure */

struct asn1_pctx_st
	{
	unsigned long flags;
	unsigned long nm_flags;
	unsigned long cert_flags;
	unsigned long oid_flags;
	unsigned long str_flags;
	} /* ASN1_PCTX */;

/* ASN1 scan context structure */

struct asn1_sctx_st
	{
	/* The ASN1_ITEM associated with this field */
	const ASN1_ITEM *it;
	/* If ASN1_TEMPLATE associated with this field */
	const ASN1_TEMPLATE *tt;
	/* Various flags associated with field and context */
	unsigned long flags;
	/* If SEQUENCE OF or SET OF, field index */
	int skidx;
	/* ASN1 depth of field */
	int depth;
	/* Structure and field name */
	const char *sname, *fname;
	/* If a primitive type the type of underlying field */
	int prim_type;
	/* The field value itself */
	ASN1_VALUE **field;
	/* Callback to pass information to */
	int (*scan_cb)(ASN1_SCTX *ctx);
	/* Context specific application data */
	void *app_data;
	} /* ASN1_SCTX */;

/* ASN1 public key method structure */

struct evp_pkey_asn1_method_st
	{
	int pkey_id;
	int pkey_base_id;
	unsigned long pkey_flags;

	char *pem_str;
	char *info;

	int (*pub_decode)(EVP_PKEY *pk, X509_PUBKEY *pub);
	int (*pub_encode)(X509_PUBKEY *pub, const EVP_PKEY *pk);
	int (*pub_cmp)(const EVP_PKEY *a, const EVP_PKEY *b);
	int (*pub_print)(BIO *out, const EVP_PKEY *pkey, int indent,
							ASN1_PCTX *pctx);

	int (*priv_decode)(EVP_PKEY *pk, PKCS8_PRIV_KEY_INFO *p8inf);
	int (*priv_encode)(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk);
	int (*priv_print)(BIO *out, const EVP_PKEY *pkey, int indent,
							ASN1_PCTX *pctx);

	int (*pkey_size)(const EVP_PKEY *pk);
	int (*pkey_bits)(const EVP_PKEY *pk);
	int (*pkey_security_bits)(const EVP_PKEY *pk);

	int (*param_decode)(EVP_PKEY *pkey,
				const unsigned char **pder, int derlen);
	int (*param_encode)(const EVP_PKEY *pkey, unsigned char **pder);
	int (*param_missing)(const EVP_PKEY *pk);
	int (*param_copy)(EVP_PKEY *to, const EVP_PKEY *from);
	int (*param_cmp)(const EVP_PKEY *a, const EVP_PKEY *b);
	int (*param_print)(BIO *out, const EVP_PKEY *pkey, int indent,
							ASN1_PCTX *pctx);
	int (*sig_print)(BIO *out,
			 const X509_ALGOR *sigalg, const ASN1_STRING *sig,
					 int indent, ASN1_PCTX *pctx);


	void (*pkey_free)(EVP_PKEY *pkey);
	int (*pkey_ctrl)(EVP_PKEY *pkey, int op, long arg1, void *arg2);

	/* Legacy functions for old PEM */

	int (*old_priv_decode)(EVP_PKEY *pkey,
				const unsigned char **pder, int derlen);
	int (*old_priv_encode)(const EVP_PKEY *pkey, unsigned char **pder);
	/* Custom ASN1 signature verification */
	int (*item_verify)(EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
				X509_ALGOR *a, ASN1_BIT_STRING *sig,
				EVP_PKEY *pkey);
	int (*item_sign)(EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
				X509_ALGOR *alg1, X509_ALGOR *alg2, 
				ASN1_BIT_STRING *sig);

	} /* EVP_PKEY_ASN1_METHOD */;

/* Method to handle CRL access.
 * In general a CRL could be very large (several Mb) and can consume large
 * amounts of resources if stored in memory by multiple processes.
 * This method allows general CRL operations to be redirected to more
 * efficient callbacks: for example a CRL entry database.
 */

#define X509_CRL_METHOD_DYNAMIC		1

struct x509_crl_method_st
	{
	int flags;
	int (*crl_init)(X509_CRL *crl);
	int (*crl_free)(X509_CRL *crl);
	int (*crl_lookup)(X509_CRL *crl, X509_REVOKED **ret,
				ASN1_INTEGER *ser, X509_NAME *issuer);
	int (*crl_verify)(X509_CRL *crl, EVP_PKEY *pk);
	};
Commit	Line	Data
56defd9a	1	/* asn1t.h */
2e597528	2	/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
db98bbc1	3	* project 2006.
56defd9a DSH	4	*/
56defd9a DSH	5	/* ====================================================================
db98bbc1	6	* Copyright (c) 2006 The OpenSSL Project. All rights reserved.
56defd9a DSH	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	*
	12	* 1. Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	*
	15	* 2. Redistributions in binary form must reproduce the above copyright
	16	* notice, this list of conditions and the following disclaimer in
	17	* the documentation and/or other materials provided with the
	18	* distribution.
	19	*
	20	* 3. All advertising materials mentioning features or use of this
	21	* software must display the following acknowledgment:
	22	* "This product includes software developed by the OpenSSL Project
	23	* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
	24	*
	25	* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
	26	* endorse or promote products derived from this software without
	27	* prior written permission. For written permission, please contact
	28	* licensing@OpenSSL.org.
	29	*
	30	* 5. Products derived from this software may not be called "OpenSSL"
	31	* nor may "OpenSSL" appear in their names without prior written
	32	* permission of the OpenSSL Project.
	33	*
	34	* 6. Redistributions of any form whatsoever must retain the following
	35	* acknowledgment:
	36	* "This product includes software developed by the OpenSSL Project
	37	* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
	38	*
	39	* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
	40	* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	41	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	42	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
	43	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	44	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	45	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	46	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	47	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	48	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	49	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
	50	* OF THE POSSIBILITY OF SUCH DAMAGE.
	51	* ====================================================================
	52	*
	53	* This product includes cryptographic software written by Eric Young
	54	* (eay@cryptsoft.com). This product includes software written by Tim
	55	* Hudson (tjh@cryptsoft.com).
	56	*
	57	*/
	58
	59	/* Internal ASN1 structures and functions: not for application use */
	60
1c455bc0 DSH	61	int asn1_utctime_to_tm(struct tm tm, const ASN1_UTCTIME d);
	62	int asn1_generalizedtime_to_tm(struct tm tm, const ASN1_GENERALIZEDTIME d);
	63
56defd9a DSH	64	/* ASN1 print context structure */
	65
	66	struct asn1_pctx_st
	67	{
	68	unsigned long flags;
	69	unsigned long nm_flags;
	70	unsigned long cert_flags;
	71	unsigned long oid_flags;
	72	unsigned long str_flags;
	73	} /* ASN1_PCTX */;
18e377b4	74
d7d5a55d DSH	75	/* ASN1 scan context structure */
	76
	77	struct asn1_sctx_st
	78	{
	79	/* The ASN1_ITEM associated with this field */
	80	const ASN1_ITEM *it;
	81	/* If ASN1_TEMPLATE associated with this field */
	82	const ASN1_TEMPLATE *tt;
	83	/* Various flags associated with field and context */
	84	unsigned long flags;
	85	/* If SEQUENCE OF or SET OF, field index */
	86	int skidx;
	87	/* ASN1 depth of field */
	88	int depth;
	89	/* Structure and field name */
	90	const char sname, fname;
	91	/* If a primitive type the type of underlying field */
	92	int prim_type;
	93	/* The field value itself */
	94	ASN1_VALUE **field;
	95	/* Callback to pass information to */
	96	int (scan_cb)(ASN1_SCTX ctx);
	97	/* Context specific application data */
	98	void *app_data;
	99	} /* ASN1_SCTX */;
	100
18e377b4 DSH	101	/* ASN1 public key method structure */
18e377b4 DSH	102
18e377b4 DSH	103	struct evp_pkey_asn1_method_st
	104	{
	105	int pkey_id;
	106	int pkey_base_id;
	107	unsigned long pkey_flags;
	108
d82e2718 DSH	109	char *pem_str;
	110	char *info;
	111
18e377b4 DSH	112	int (pub_decode)(EVP_PKEY pk, X509_PUBKEY *pub);
	113	int (pub_encode)(X509_PUBKEY pub, const EVP_PKEY *pk);
	114	int (pub_cmp)(const EVP_PKEY a, const EVP_PKEY *b);
	115	int (pub_print)(BIO out, const EVP_PKEY *pkey, int indent,
6343829a	116	ASN1_PCTX *pctx);
18e377b4 DSH	117
	118	int (priv_decode)(EVP_PKEY pk, PKCS8_PRIV_KEY_INFO *p8inf);
	119	int (priv_encode)(PKCS8_PRIV_KEY_INFO p8, const EVP_PKEY *pk);
	120	int (priv_print)(BIO out, const EVP_PKEY *pkey, int indent,
6343829a	121	ASN1_PCTX *pctx);
18e377b4 DSH	122
	123	int (pkey_size)(const EVP_PKEY pk);
	124	int (pkey_bits)(const EVP_PKEY pk);
2514fa79	125	int (pkey_security_bits)(const EVP_PKEY pk);
18e377b4	126
db98bbc1	127	int (param_decode)(EVP_PKEY pkey,
6343829a	128	const unsigned char **pder, int derlen);
db98bbc1	129	int (param_encode)(const EVP_PKEY pkey, unsigned char **pder);
18e377b4 DSH	130	int (param_missing)(const EVP_PKEY pk);
	131	int (param_copy)(EVP_PKEY to, const EVP_PKEY *from);
	132	int (param_cmp)(const EVP_PKEY a, const EVP_PKEY *b);
	133	int (param_print)(BIO out, const EVP_PKEY *pkey, int indent,
6343829a	134	ASN1_PCTX *pctx);
fa1ba589 DSH	135	int (sig_print)(BIO out,
	136	const X509_ALGOR sigalg, const ASN1_STRING sig,
	137	int indent, ASN1_PCTX *pctx);
18e377b4	138
31904ecd	139
18e377b4	140	void (pkey_free)(EVP_PKEY pkey);
492a9e24	141	int (pkey_ctrl)(EVP_PKEY pkey, int op, long arg1, void *arg2);
e4263314 DSH	142
	143	/* Legacy functions for old PEM */
	144
	145	int (old_priv_decode)(EVP_PKEY pkey,
6343829a	146	const unsigned char **pder, int derlen);
e4263314	147	int (old_priv_encode)(const EVP_PKEY pkey, unsigned char **pder);
31904ecd DSH	148	/* Custom ASN1 signature verification */
	149	int (item_verify)(EVP_MD_CTX ctx, const ASN1_ITEM it, void asn,
	150	X509_ALGOR a, ASN1_BIT_STRING sig,
	151	EVP_PKEY *pkey);
85522a07 DSH	152	int (item_sign)(EVP_MD_CTX ctx, const ASN1_ITEM it, void asn,
	153	X509_ALGOR alg1, X509_ALGOR alg2,
	154	ASN1_BIT_STRING *sig);
e4263314	155
18e377b4	156	} /* EVP_PKEY_ASN1_METHOD */;
010fa0b3 DSH	157
	158	/* Method to handle CRL access.
	159	* In general a CRL could be very large (several Mb) and can consume large
	160	* amounts of resources if stored in memory by multiple processes.
	161	* This method allows general CRL operations to be redirected to more
	162	* efficient callbacks: for example a CRL entry database.
	163	*/
	164
f4c630ab DSH	165	#define X509_CRL_METHOD_DYNAMIC 1
f4c630ab DSH	166
010fa0b3 DSH	167	struct x509_crl_method_st
010fa0b3 DSH	168	{
f4c630ab	169	int flags;
010fa0b3 DSH	170	int (crl_init)(X509_CRL crl);
010fa0b3 DSH	171	int (crl_free)(X509_CRL crl);
d0fff69d DSH	172	int (crl_lookup)(X509_CRL crl, X509_REVOKED **ret,
d0fff69d DSH	173	ASN1_INTEGER ser, X509_NAME issuer);
010fa0b3 DSH	174	int (crl_verify)(X509_CRL crl, EVP_PKEY *pk);
010fa0b3 DSH	175	};