1/*
2 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the OpenSSL license (the "License").  You may not use
5 * this file except in compliance with the License.  You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10/* Internal ASN1 structures and functions: not for application use */
11
12/* ASN1 public key method structure */
13
14struct evp_pkey_asn1_method_st {
15    int pkey_id;
16    int pkey_base_id;
17    unsigned long pkey_flags;
18    char *pem_str;
19    char *info;
20    int (*pub_decode) (EVP_PKEY *pk, X509_PUBKEY *pub);
21    int (*pub_encode) (X509_PUBKEY *pub, const EVP_PKEY *pk);
22    int (*pub_cmp) (const EVP_PKEY *a, const EVP_PKEY *b);
23    int (*pub_print) (BIO *out, const EVP_PKEY *pkey, int indent,
24                      ASN1_PCTX *pctx);
25    int (*priv_decode) (EVP_PKEY *pk, const PKCS8_PRIV_KEY_INFO *p8inf);
26    int (*priv_encode) (PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk);
27    int (*priv_print) (BIO *out, const EVP_PKEY *pkey, int indent,
28                       ASN1_PCTX *pctx);
29    int (*pkey_size) (const EVP_PKEY *pk);
30    int (*pkey_bits) (const EVP_PKEY *pk);
31    int (*pkey_security_bits) (const EVP_PKEY *pk);
32    int (*param_decode) (EVP_PKEY *pkey,
33                         const unsigned char **pder, int derlen);
34    int (*param_encode) (const EVP_PKEY *pkey, unsigned char **pder);
35    int (*param_missing) (const EVP_PKEY *pk);
36    int (*param_copy) (EVP_PKEY *to, const EVP_PKEY *from);
37    int (*param_cmp) (const EVP_PKEY *a, const EVP_PKEY *b);
38    int (*param_print) (BIO *out, const EVP_PKEY *pkey, int indent,
39                        ASN1_PCTX *pctx);
40    int (*sig_print) (BIO *out,
41                      const X509_ALGOR *sigalg, const ASN1_STRING *sig,
42                      int indent, ASN1_PCTX *pctx);
43    void (*pkey_free) (EVP_PKEY *pkey);
44    int (*pkey_ctrl) (EVP_PKEY *pkey, int op, long arg1, void *arg2);
45    /* Legacy functions for old PEM */
46    int (*old_priv_decode) (EVP_PKEY *pkey,
47                            const unsigned char **pder, int derlen);
48    int (*old_priv_encode) (const EVP_PKEY *pkey, unsigned char **pder);
49    /* Custom ASN1 signature verification */
50    int (*item_verify) (EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
51                        X509_ALGOR *a, ASN1_BIT_STRING *sig, EVP_PKEY *pkey);
52    int (*item_sign) (EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
53                      X509_ALGOR *alg1, X509_ALGOR *alg2,
54                      ASN1_BIT_STRING *sig);
55    int (*siginf_set) (X509_SIG_INFO *siginf, const X509_ALGOR *alg,
56                       const ASN1_STRING *sig);
57    /* Check */
58    int (*pkey_check) (const EVP_PKEY *pk);
59    int (*pkey_public_check) (const EVP_PKEY *pk);
60    int (*pkey_param_check) (const EVP_PKEY *pk);
61    /* Get/set raw private/public key data */
62    int (*set_priv_key) (EVP_PKEY *pk, const unsigned char *priv, size_t len);
63    int (*set_pub_key) (EVP_PKEY *pk, const unsigned char *pub, size_t len);
64    int (*get_priv_key) (const EVP_PKEY *pk, unsigned char *priv, size_t *len);
65    int (*get_pub_key) (const EVP_PKEY *pk, unsigned char *pub, size_t *len);
66} /* EVP_PKEY_ASN1_METHOD */ ;
67
68DEFINE_STACK_OF_CONST(EVP_PKEY_ASN1_METHOD)
69
70extern const EVP_PKEY_ASN1_METHOD cmac_asn1_meth;
71extern const EVP_PKEY_ASN1_METHOD dh_asn1_meth;
72extern const EVP_PKEY_ASN1_METHOD dhx_asn1_meth;
73extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meths[5];
74extern const EVP_PKEY_ASN1_METHOD eckey_asn1_meth;
75extern const EVP_PKEY_ASN1_METHOD ecx25519_asn1_meth;
76extern const EVP_PKEY_ASN1_METHOD ecx448_asn1_meth;
77extern const EVP_PKEY_ASN1_METHOD ed25519_asn1_meth;
78extern const EVP_PKEY_ASN1_METHOD ed448_asn1_meth;
79extern const EVP_PKEY_ASN1_METHOD sm2_asn1_meth;
80extern const EVP_PKEY_ASN1_METHOD poly1305_asn1_meth;
81
82extern const EVP_PKEY_ASN1_METHOD hmac_asn1_meth;
83extern const EVP_PKEY_ASN1_METHOD rsa_asn1_meths[2];
84extern const EVP_PKEY_ASN1_METHOD rsa_pss_asn1_meth;
85extern const EVP_PKEY_ASN1_METHOD siphash_asn1_meth;
86
87/*
88 * These are used internally in the ASN1_OBJECT to keep track of whether the
89 * names and data need to be free()ed
90 */
91# define ASN1_OBJECT_FLAG_DYNAMIC         0x01/* internal use */
92# define ASN1_OBJECT_FLAG_CRITICAL        0x02/* critical x509v3 object id */
93# define ASN1_OBJECT_FLAG_DYNAMIC_STRINGS 0x04/* internal use */
94# define ASN1_OBJECT_FLAG_DYNAMIC_DATA    0x08/* internal use */
95struct asn1_object_st {
96    const char *sn, *ln;
97    int nid;
98    int length;
99    const unsigned char *data;  /* data remains const after init */
100    int flags;                  /* Should we free this one */
101};
102
103/* ASN1 print context structure */
104
105struct asn1_pctx_st {
106    unsigned long flags;
107    unsigned long nm_flags;
108    unsigned long cert_flags;
109    unsigned long oid_flags;
110    unsigned long str_flags;
111} /* ASN1_PCTX */ ;
112
113int asn1_d2i_read_bio(BIO *in, BUF_MEM **pb);
114