2 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
10 /* Internal ASN1 structures and functions: not for application use */
12 /* ASN1 public key method structure */
14 #include <openssl/core.h>
16 struct evp_pkey_asn1_method_st
{
19 unsigned long pkey_flags
;
22 int (*pub_decode
) (EVP_PKEY
*pk
, X509_PUBKEY
*pub
);
23 int (*pub_encode
) (X509_PUBKEY
*pub
, const EVP_PKEY
*pk
);
24 int (*pub_cmp
) (const EVP_PKEY
*a
, const EVP_PKEY
*b
);
25 int (*pub_print
) (BIO
*out
, const EVP_PKEY
*pkey
, int indent
,
27 int (*priv_decode
) (EVP_PKEY
*pk
, const PKCS8_PRIV_KEY_INFO
*p8inf
);
28 int (*priv_encode
) (PKCS8_PRIV_KEY_INFO
*p8
, const EVP_PKEY
*pk
);
29 int (*priv_print
) (BIO
*out
, const EVP_PKEY
*pkey
, int indent
,
31 int (*pkey_size
) (const EVP_PKEY
*pk
);
32 int (*pkey_bits
) (const EVP_PKEY
*pk
);
33 int (*pkey_security_bits
) (const EVP_PKEY
*pk
);
34 int (*param_decode
) (EVP_PKEY
*pkey
,
35 const unsigned char **pder
, int derlen
);
36 int (*param_encode
) (const EVP_PKEY
*pkey
, unsigned char **pder
);
37 int (*param_missing
) (const EVP_PKEY
*pk
);
38 int (*param_copy
) (EVP_PKEY
*to
, const EVP_PKEY
*from
);
39 int (*param_cmp
) (const EVP_PKEY
*a
, const EVP_PKEY
*b
);
40 int (*param_print
) (BIO
*out
, const EVP_PKEY
*pkey
, int indent
,
42 int (*sig_print
) (BIO
*out
,
43 const X509_ALGOR
*sigalg
, const ASN1_STRING
*sig
,
44 int indent
, ASN1_PCTX
*pctx
);
45 void (*pkey_free
) (EVP_PKEY
*pkey
);
46 int (*pkey_ctrl
) (EVP_PKEY
*pkey
, int op
, long arg1
, void *arg2
);
47 /* Legacy functions for old PEM */
48 int (*old_priv_decode
) (EVP_PKEY
*pkey
,
49 const unsigned char **pder
, int derlen
);
50 int (*old_priv_encode
) (const EVP_PKEY
*pkey
, unsigned char **pder
);
51 /* Custom ASN1 signature verification */
52 int (*item_verify
) (EVP_MD_CTX
*ctx
, const ASN1_ITEM
*it
, void *asn
,
53 X509_ALGOR
*a
, ASN1_BIT_STRING
*sig
, EVP_PKEY
*pkey
);
54 int (*item_sign
) (EVP_MD_CTX
*ctx
, const ASN1_ITEM
*it
, void *asn
,
55 X509_ALGOR
*alg1
, X509_ALGOR
*alg2
,
56 ASN1_BIT_STRING
*sig
);
57 int (*siginf_set
) (X509_SIG_INFO
*siginf
, const X509_ALGOR
*alg
,
58 const ASN1_STRING
*sig
);
60 int (*pkey_check
) (const EVP_PKEY
*pk
);
61 int (*pkey_public_check
) (const EVP_PKEY
*pk
);
62 int (*pkey_param_check
) (const EVP_PKEY
*pk
);
63 /* Get/set raw private/public key data */
64 int (*set_priv_key
) (EVP_PKEY
*pk
, const unsigned char *priv
, size_t len
);
65 int (*set_pub_key
) (EVP_PKEY
*pk
, const unsigned char *pub
, size_t len
);
66 int (*get_priv_key
) (const EVP_PKEY
*pk
, unsigned char *priv
, size_t *len
);
67 int (*get_pub_key
) (const EVP_PKEY
*pk
, unsigned char *pub
, size_t *len
);
70 * TODO: Make sure these functions are defined for key types that are
71 * implemented in providers.
73 /* Exports and imports to / from providers */
74 size_t (*dirty_cnt
) (const EVP_PKEY
*pk
);
75 int (*export_to
) (const EVP_PKEY
*pk
, void *to_keydata
,
76 EVP_KEYMGMT
*to_keymgmt
, OPENSSL_CTX
*libctx
,
78 OSSL_CALLBACK
*import_from
;
80 int (*priv_decode_with_libctx
) (EVP_PKEY
*pk
,
81 const PKCS8_PRIV_KEY_INFO
*p8inf
,
84 } /* EVP_PKEY_ASN1_METHOD */ ;
86 DEFINE_STACK_OF_CONST(EVP_PKEY_ASN1_METHOD
)
88 extern const EVP_PKEY_ASN1_METHOD cmac_asn1_meth
;
89 extern const EVP_PKEY_ASN1_METHOD dh_asn1_meth
;
90 extern const EVP_PKEY_ASN1_METHOD dhx_asn1_meth
;
91 extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meths
[5];
92 extern const EVP_PKEY_ASN1_METHOD eckey_asn1_meth
;
93 extern const EVP_PKEY_ASN1_METHOD ecx25519_asn1_meth
;
94 extern const EVP_PKEY_ASN1_METHOD ecx448_asn1_meth
;
95 extern const EVP_PKEY_ASN1_METHOD ed25519_asn1_meth
;
96 extern const EVP_PKEY_ASN1_METHOD ed448_asn1_meth
;
97 extern const EVP_PKEY_ASN1_METHOD sm2_asn1_meth
;
98 extern const EVP_PKEY_ASN1_METHOD poly1305_asn1_meth
;
100 extern const EVP_PKEY_ASN1_METHOD hmac_asn1_meth
;
101 extern const EVP_PKEY_ASN1_METHOD rsa_asn1_meths
[2];
102 extern const EVP_PKEY_ASN1_METHOD rsa_pss_asn1_meth
;
103 extern const EVP_PKEY_ASN1_METHOD siphash_asn1_meth
;
106 * These are used internally in the ASN1_OBJECT to keep track of whether the
107 * names and data need to be free()ed
109 # define ASN1_OBJECT_FLAG_DYNAMIC 0x01/* internal use */
110 # define ASN1_OBJECT_FLAG_CRITICAL 0x02/* critical x509v3 object id */
111 # define ASN1_OBJECT_FLAG_DYNAMIC_STRINGS 0x04/* internal use */
112 # define ASN1_OBJECT_FLAG_DYNAMIC_DATA 0x08/* internal use */
113 struct asn1_object_st
{
117 const unsigned char *data
; /* data remains const after init */
118 int flags
; /* Should we free this one */
121 /* ASN1 print context structure */
123 struct asn1_pctx_st
{
125 unsigned long nm_flags
;
126 unsigned long cert_flags
;
127 unsigned long oid_flags
;
128 unsigned long str_flags
;
131 int asn1_d2i_read_bio(BIO
*in
, BUF_MEM
**pb
);