xref: /netbsd-src/crypto/external/bsd/openssl/dist/include/internal/der.h (revision b0d1725196a7921d003d2c66a14f186abda4176b)
1*b0d17251Schristos /*
2*b0d17251Schristos  * Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
3*b0d17251Schristos  *
4*b0d17251Schristos  * Licensed under the Apache License 2.0 (the "License").  You may not use
5*b0d17251Schristos  * this file except in compliance with the License.  You can obtain a copy
6*b0d17251Schristos  * in the file LICENSE in the source distribution or at
7*b0d17251Schristos  * https://www.openssl.org/source/license.html
8*b0d17251Schristos  */
9*b0d17251Schristos 
10*b0d17251Schristos #include <openssl/bn.h>
11*b0d17251Schristos #include "internal/packet.h"
12*b0d17251Schristos 
13*b0d17251Schristos /*
14*b0d17251Schristos  * NOTE: X.690 numbers the identifier octet bits 1 to 8.
15*b0d17251Schristos  * We use the same numbering in comments here.
16*b0d17251Schristos  */
17*b0d17251Schristos 
18*b0d17251Schristos /* Well known primitive tags */
19*b0d17251Schristos 
20*b0d17251Schristos /*
21*b0d17251Schristos  * DER UNIVERSAL tags, occupying bits 1-5 in the DER identifier byte
22*b0d17251Schristos  * These are only valid for the UNIVERSAL class.  With the other classes,
23*b0d17251Schristos  * these bits have a different meaning.
24*b0d17251Schristos  */
25*b0d17251Schristos #define DER_P_EOC                       0 /* BER End Of Contents tag */
26*b0d17251Schristos #define DER_P_BOOLEAN                   1
27*b0d17251Schristos #define DER_P_INTEGER                   2
28*b0d17251Schristos #define DER_P_BIT_STRING                3
29*b0d17251Schristos #define DER_P_OCTET_STRING              4
30*b0d17251Schristos #define DER_P_NULL                      5
31*b0d17251Schristos #define DER_P_OBJECT                    6
32*b0d17251Schristos #define DER_P_OBJECT_DESCRIPTOR         7
33*b0d17251Schristos #define DER_P_EXTERNAL                  8
34*b0d17251Schristos #define DER_P_REAL                      9
35*b0d17251Schristos #define DER_P_ENUMERATED               10
36*b0d17251Schristos #define DER_P_UTF8STRING               12
37*b0d17251Schristos #define DER_P_SEQUENCE                 16
38*b0d17251Schristos #define DER_P_SET                      17
39*b0d17251Schristos #define DER_P_NUMERICSTRING            18
40*b0d17251Schristos #define DER_P_PRINTABLESTRING          19
41*b0d17251Schristos #define DER_P_T61STRING                20
42*b0d17251Schristos #define DER_P_VIDEOTEXSTRING           21
43*b0d17251Schristos #define DER_P_IA5STRING                22
44*b0d17251Schristos #define DER_P_UTCTIME                  23
45*b0d17251Schristos #define DER_P_GENERALIZEDTIME          24
46*b0d17251Schristos #define DER_P_GRAPHICSTRING            25
47*b0d17251Schristos #define DER_P_ISO64STRING              26
48*b0d17251Schristos #define DER_P_GENERALSTRING            27
49*b0d17251Schristos #define DER_P_UNIVERSALSTRING          28
50*b0d17251Schristos #define DER_P_BMPSTRING                30
51*b0d17251Schristos 
52*b0d17251Schristos /* DER Flags, occupying bit 6 in the DER identifier byte */
53*b0d17251Schristos #define DER_F_PRIMITIVE              0x00
54*b0d17251Schristos #define DER_F_CONSTRUCTED            0x20
55*b0d17251Schristos 
56*b0d17251Schristos /* DER classes tags, occupying bits 7-8 in the DER identifier byte */
57*b0d17251Schristos #define DER_C_UNIVERSAL              0x00
58*b0d17251Schristos #define DER_C_APPLICATION            0x40
59*b0d17251Schristos #define DER_C_CONTEXT                0x80
60*b0d17251Schristos #define DER_C_PRIVATE                0xC0
61*b0d17251Schristos 
62*b0d17251Schristos /*
63*b0d17251Schristos  * Run-time constructors.
64*b0d17251Schristos  *
65*b0d17251Schristos  * They all construct DER backwards, so care should be taken to use them
66*b0d17251Schristos  * that way.
67*b0d17251Schristos  */
68*b0d17251Schristos 
69*b0d17251Schristos /* This can be used for all items that don't have a context */
70*b0d17251Schristos #define DER_NO_CONTEXT  -1
71*b0d17251Schristos 
72*b0d17251Schristos int ossl_DER_w_precompiled(WPACKET *pkt, int tag,
73*b0d17251Schristos                            const unsigned char *precompiled,
74*b0d17251Schristos                            size_t precompiled_n);
75*b0d17251Schristos 
76*b0d17251Schristos int ossl_DER_w_boolean(WPACKET *pkt, int tag, int b);
77*b0d17251Schristos int ossl_DER_w_uint32(WPACKET *pkt, int tag, uint32_t v);
78*b0d17251Schristos int ossl_DER_w_bn(WPACKET *pkt, int tag, const BIGNUM *v);
79*b0d17251Schristos int ossl_DER_w_null(WPACKET *pkt, int tag);
80*b0d17251Schristos int ossl_DER_w_octet_string(WPACKET *pkt, int tag,
81*b0d17251Schristos                             const unsigned char *data, size_t data_n);
82*b0d17251Schristos int ossl_DER_w_octet_string_uint32(WPACKET *pkt, int tag, uint32_t value);
83*b0d17251Schristos 
84*b0d17251Schristos /*
85*b0d17251Schristos  * All constructors for constructed elements have a begin and a end function
86*b0d17251Schristos  */
87*b0d17251Schristos int ossl_DER_w_begin_sequence(WPACKET *pkt, int tag);
88*b0d17251Schristos int ossl_DER_w_end_sequence(WPACKET *pkt, int tag);
89