xref: /optee_os/lib/libmbedtls/mbedtls/library/x509write_csr.c (revision c6672fdcd95b9a895eb5b4191f8ba3483a34a442)
1*c6672fdcSEdison Ai // SPDX-License-Identifier: Apache-2.0
2817466cbSJens Wiklander /*
3817466cbSJens Wiklander  *  X.509 Certificate Signing Request writing
4817466cbSJens Wiklander  *
5817466cbSJens Wiklander  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
6817466cbSJens Wiklander  *
7817466cbSJens Wiklander  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
8817466cbSJens Wiklander  *  not use this file except in compliance with the License.
9817466cbSJens Wiklander  *  You may obtain a copy of the License at
10817466cbSJens Wiklander  *
11817466cbSJens Wiklander  *  http://www.apache.org/licenses/LICENSE-2.0
12817466cbSJens Wiklander  *
13817466cbSJens Wiklander  *  Unless required by applicable law or agreed to in writing, software
14817466cbSJens Wiklander  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15817466cbSJens Wiklander  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16817466cbSJens Wiklander  *  See the License for the specific language governing permissions and
17817466cbSJens Wiklander  *  limitations under the License.
18817466cbSJens Wiklander  *
19817466cbSJens Wiklander  *  This file is part of mbed TLS (https://tls.mbed.org)
20817466cbSJens Wiklander  */
21817466cbSJens Wiklander /*
22817466cbSJens Wiklander  * References:
23817466cbSJens Wiklander  * - CSRs: PKCS#10 v1.7 aka RFC 2986
24817466cbSJens Wiklander  * - attributes: PKCS#9 v2.0 aka RFC 2985
25817466cbSJens Wiklander  */
26817466cbSJens Wiklander 
27817466cbSJens Wiklander #if !defined(MBEDTLS_CONFIG_FILE)
28817466cbSJens Wiklander #include "mbedtls/config.h"
29817466cbSJens Wiklander #else
30817466cbSJens Wiklander #include MBEDTLS_CONFIG_FILE
31817466cbSJens Wiklander #endif
32817466cbSJens Wiklander 
33817466cbSJens Wiklander #if defined(MBEDTLS_X509_CSR_WRITE_C)
34817466cbSJens Wiklander 
35817466cbSJens Wiklander #include "mbedtls/x509_csr.h"
36817466cbSJens Wiklander #include "mbedtls/oid.h"
37817466cbSJens Wiklander #include "mbedtls/asn1write.h"
38817466cbSJens Wiklander 
39817466cbSJens Wiklander #include <string.h>
40817466cbSJens Wiklander #include <stdlib.h>
41817466cbSJens Wiklander 
42817466cbSJens Wiklander #if defined(MBEDTLS_PEM_WRITE_C)
43817466cbSJens Wiklander #include "mbedtls/pem.h"
44817466cbSJens Wiklander #endif
45817466cbSJens Wiklander 
46817466cbSJens Wiklander /* Implementation that should never be optimized out by the compiler */
47817466cbSJens Wiklander static void mbedtls_zeroize( void *v, size_t n ) {
48817466cbSJens Wiklander     volatile unsigned char *p = v; while( n-- ) *p++ = 0;
49817466cbSJens Wiklander }
50817466cbSJens Wiklander 
51817466cbSJens Wiklander void mbedtls_x509write_csr_init( mbedtls_x509write_csr *ctx )
52817466cbSJens Wiklander {
53817466cbSJens Wiklander     memset( ctx, 0, sizeof(mbedtls_x509write_csr) );
54817466cbSJens Wiklander }
55817466cbSJens Wiklander 
56817466cbSJens Wiklander void mbedtls_x509write_csr_free( mbedtls_x509write_csr *ctx )
57817466cbSJens Wiklander {
58817466cbSJens Wiklander     mbedtls_asn1_free_named_data_list( &ctx->subject );
59817466cbSJens Wiklander     mbedtls_asn1_free_named_data_list( &ctx->extensions );
60817466cbSJens Wiklander 
61817466cbSJens Wiklander     mbedtls_zeroize( ctx, sizeof(mbedtls_x509write_csr) );
62817466cbSJens Wiklander }
63817466cbSJens Wiklander 
64817466cbSJens Wiklander void mbedtls_x509write_csr_set_md_alg( mbedtls_x509write_csr *ctx, mbedtls_md_type_t md_alg )
65817466cbSJens Wiklander {
66817466cbSJens Wiklander     ctx->md_alg = md_alg;
67817466cbSJens Wiklander }
68817466cbSJens Wiklander 
69817466cbSJens Wiklander void mbedtls_x509write_csr_set_key( mbedtls_x509write_csr *ctx, mbedtls_pk_context *key )
70817466cbSJens Wiklander {
71817466cbSJens Wiklander     ctx->key = key;
72817466cbSJens Wiklander }
73817466cbSJens Wiklander 
74817466cbSJens Wiklander int mbedtls_x509write_csr_set_subject_name( mbedtls_x509write_csr *ctx,
75817466cbSJens Wiklander                                     const char *subject_name )
76817466cbSJens Wiklander {
77817466cbSJens Wiklander     return mbedtls_x509_string_to_names( &ctx->subject, subject_name );
78817466cbSJens Wiklander }
79817466cbSJens Wiklander 
80817466cbSJens Wiklander int mbedtls_x509write_csr_set_extension( mbedtls_x509write_csr *ctx,
81817466cbSJens Wiklander                                  const char *oid, size_t oid_len,
82817466cbSJens Wiklander                                  const unsigned char *val, size_t val_len )
83817466cbSJens Wiklander {
84817466cbSJens Wiklander     return mbedtls_x509_set_extension( &ctx->extensions, oid, oid_len,
85817466cbSJens Wiklander                                0, val, val_len );
86817466cbSJens Wiklander }
87817466cbSJens Wiklander 
88817466cbSJens Wiklander int mbedtls_x509write_csr_set_key_usage( mbedtls_x509write_csr *ctx, unsigned char key_usage )
89817466cbSJens Wiklander {
90817466cbSJens Wiklander     unsigned char buf[4];
91817466cbSJens Wiklander     unsigned char *c;
92817466cbSJens Wiklander     int ret;
93817466cbSJens Wiklander 
94817466cbSJens Wiklander     c = buf + 4;
95817466cbSJens Wiklander 
96817466cbSJens Wiklander     if( ( ret = mbedtls_asn1_write_bitstring( &c, buf, &key_usage, 7 ) ) != 4 )
97817466cbSJens Wiklander         return( ret );
98817466cbSJens Wiklander 
99817466cbSJens Wiklander     ret = mbedtls_x509write_csr_set_extension( ctx, MBEDTLS_OID_KEY_USAGE,
100817466cbSJens Wiklander                                        MBEDTLS_OID_SIZE( MBEDTLS_OID_KEY_USAGE ),
101817466cbSJens Wiklander                                        buf, 4 );
102817466cbSJens Wiklander     if( ret != 0 )
103817466cbSJens Wiklander         return( ret );
104817466cbSJens Wiklander 
105817466cbSJens Wiklander     return( 0 );
106817466cbSJens Wiklander }
107817466cbSJens Wiklander 
108817466cbSJens Wiklander int mbedtls_x509write_csr_set_ns_cert_type( mbedtls_x509write_csr *ctx,
109817466cbSJens Wiklander                                     unsigned char ns_cert_type )
110817466cbSJens Wiklander {
111817466cbSJens Wiklander     unsigned char buf[4];
112817466cbSJens Wiklander     unsigned char *c;
113817466cbSJens Wiklander     int ret;
114817466cbSJens Wiklander 
115817466cbSJens Wiklander     c = buf + 4;
116817466cbSJens Wiklander 
117817466cbSJens Wiklander     if( ( ret = mbedtls_asn1_write_bitstring( &c, buf, &ns_cert_type, 8 ) ) != 4 )
118817466cbSJens Wiklander         return( ret );
119817466cbSJens Wiklander 
120817466cbSJens Wiklander     ret = mbedtls_x509write_csr_set_extension( ctx, MBEDTLS_OID_NS_CERT_TYPE,
121817466cbSJens Wiklander                                        MBEDTLS_OID_SIZE( MBEDTLS_OID_NS_CERT_TYPE ),
122817466cbSJens Wiklander                                        buf, 4 );
123817466cbSJens Wiklander     if( ret != 0 )
124817466cbSJens Wiklander         return( ret );
125817466cbSJens Wiklander 
126817466cbSJens Wiklander     return( 0 );
127817466cbSJens Wiklander }
128817466cbSJens Wiklander 
129817466cbSJens Wiklander int mbedtls_x509write_csr_der( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
130817466cbSJens Wiklander                        int (*f_rng)(void *, unsigned char *, size_t),
131817466cbSJens Wiklander                        void *p_rng )
132817466cbSJens Wiklander {
133817466cbSJens Wiklander     int ret;
134817466cbSJens Wiklander     const char *sig_oid;
135817466cbSJens Wiklander     size_t sig_oid_len = 0;
136817466cbSJens Wiklander     unsigned char *c, *c2;
137817466cbSJens Wiklander     unsigned char hash[64];
138817466cbSJens Wiklander     unsigned char sig[MBEDTLS_MPI_MAX_SIZE];
139817466cbSJens Wiklander     unsigned char tmp_buf[2048];
140817466cbSJens Wiklander     size_t pub_len = 0, sig_and_oid_len = 0, sig_len;
141817466cbSJens Wiklander     size_t len = 0;
142817466cbSJens Wiklander     mbedtls_pk_type_t pk_alg;
143817466cbSJens Wiklander 
144817466cbSJens Wiklander     /*
145817466cbSJens Wiklander      * Prepare data to be signed in tmp_buf
146817466cbSJens Wiklander      */
147817466cbSJens Wiklander     c = tmp_buf + sizeof( tmp_buf );
148817466cbSJens Wiklander 
149817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_x509_write_extensions( &c, tmp_buf, ctx->extensions ) );
150817466cbSJens Wiklander 
151817466cbSJens Wiklander     if( len )
152817466cbSJens Wiklander     {
153817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, tmp_buf, len ) );
154817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, tmp_buf, MBEDTLS_ASN1_CONSTRUCTED |
155817466cbSJens Wiklander                                                         MBEDTLS_ASN1_SEQUENCE ) );
156817466cbSJens Wiklander 
157817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, tmp_buf, len ) );
158817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, tmp_buf, MBEDTLS_ASN1_CONSTRUCTED |
159817466cbSJens Wiklander                                                         MBEDTLS_ASN1_SET ) );
160817466cbSJens Wiklander 
161817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_oid( &c, tmp_buf, MBEDTLS_OID_PKCS9_CSR_EXT_REQ,
162817466cbSJens Wiklander                                           MBEDTLS_OID_SIZE( MBEDTLS_OID_PKCS9_CSR_EXT_REQ ) ) );
163817466cbSJens Wiklander 
164817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, tmp_buf, len ) );
165817466cbSJens Wiklander         MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, tmp_buf, MBEDTLS_ASN1_CONSTRUCTED |
166817466cbSJens Wiklander                                                         MBEDTLS_ASN1_SEQUENCE ) );
167817466cbSJens Wiklander     }
168817466cbSJens Wiklander 
169817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, tmp_buf, len ) );
170817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, tmp_buf, MBEDTLS_ASN1_CONSTRUCTED |
171817466cbSJens Wiklander                                                     MBEDTLS_ASN1_CONTEXT_SPECIFIC ) );
172817466cbSJens Wiklander 
173817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( pub_len, mbedtls_pk_write_pubkey_der( ctx->key,
174817466cbSJens Wiklander                                                 tmp_buf, c - tmp_buf ) );
175817466cbSJens Wiklander     c -= pub_len;
176817466cbSJens Wiklander     len += pub_len;
177817466cbSJens Wiklander 
178817466cbSJens Wiklander     /*
179817466cbSJens Wiklander      *  Subject  ::=  Name
180817466cbSJens Wiklander      */
181817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_x509_write_names( &c, tmp_buf, ctx->subject ) );
182817466cbSJens Wiklander 
183817466cbSJens Wiklander     /*
184817466cbSJens Wiklander      *  Version  ::=  INTEGER  {  v1(0), v2(1), v3(2)  }
185817466cbSJens Wiklander      */
186817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_int( &c, tmp_buf, 0 ) );
187817466cbSJens Wiklander 
188817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c, tmp_buf, len ) );
189817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c, tmp_buf, MBEDTLS_ASN1_CONSTRUCTED |
190817466cbSJens Wiklander                                                     MBEDTLS_ASN1_SEQUENCE ) );
191817466cbSJens Wiklander 
192817466cbSJens Wiklander     /*
193817466cbSJens Wiklander      * Prepare signature
194817466cbSJens Wiklander      */
195817466cbSJens Wiklander     mbedtls_md( mbedtls_md_info_from_type( ctx->md_alg ), c, len, hash );
196817466cbSJens Wiklander 
197817466cbSJens Wiklander     pk_alg = mbedtls_pk_get_type( ctx->key );
198817466cbSJens Wiklander     if( pk_alg == MBEDTLS_PK_ECKEY )
199817466cbSJens Wiklander         pk_alg = MBEDTLS_PK_ECDSA;
200817466cbSJens Wiklander 
201817466cbSJens Wiklander     if( ( ret = mbedtls_pk_sign( ctx->key, ctx->md_alg, hash, 0, sig, &sig_len,
202817466cbSJens Wiklander                          f_rng, p_rng ) ) != 0 ||
203817466cbSJens Wiklander         ( ret = mbedtls_oid_get_oid_by_sig_alg( pk_alg, ctx->md_alg,
204817466cbSJens Wiklander                                         &sig_oid, &sig_oid_len ) ) != 0 )
205817466cbSJens Wiklander     {
206817466cbSJens Wiklander         return( ret );
207817466cbSJens Wiklander     }
208817466cbSJens Wiklander 
209817466cbSJens Wiklander     /*
210817466cbSJens Wiklander      * Write data to output buffer
211817466cbSJens Wiklander      */
212817466cbSJens Wiklander     c2 = buf + size;
213817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( sig_and_oid_len, mbedtls_x509_write_sig( &c2, buf,
214817466cbSJens Wiklander                                         sig_oid, sig_oid_len, sig, sig_len ) );
215817466cbSJens Wiklander 
216817466cbSJens Wiklander     if( len > (size_t)( c2 - buf ) )
217817466cbSJens Wiklander         return( MBEDTLS_ERR_ASN1_BUF_TOO_SMALL );
218817466cbSJens Wiklander 
219817466cbSJens Wiklander     c2 -= len;
220817466cbSJens Wiklander     memcpy( c2, c, len );
221817466cbSJens Wiklander 
222817466cbSJens Wiklander     len += sig_and_oid_len;
223817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_len( &c2, buf, len ) );
224817466cbSJens Wiklander     MBEDTLS_ASN1_CHK_ADD( len, mbedtls_asn1_write_tag( &c2, buf, MBEDTLS_ASN1_CONSTRUCTED |
225817466cbSJens Wiklander                                                  MBEDTLS_ASN1_SEQUENCE ) );
226817466cbSJens Wiklander 
227817466cbSJens Wiklander     return( (int) len );
228817466cbSJens Wiklander }
229817466cbSJens Wiklander 
230817466cbSJens Wiklander #define PEM_BEGIN_CSR           "-----BEGIN CERTIFICATE REQUEST-----\n"
231817466cbSJens Wiklander #define PEM_END_CSR             "-----END CERTIFICATE REQUEST-----\n"
232817466cbSJens Wiklander 
233817466cbSJens Wiklander #if defined(MBEDTLS_PEM_WRITE_C)
234817466cbSJens Wiklander int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
235817466cbSJens Wiklander                        int (*f_rng)(void *, unsigned char *, size_t),
236817466cbSJens Wiklander                        void *p_rng )
237817466cbSJens Wiklander {
238817466cbSJens Wiklander     int ret;
239817466cbSJens Wiklander     unsigned char output_buf[4096];
240817466cbSJens Wiklander     size_t olen = 0;
241817466cbSJens Wiklander 
242817466cbSJens Wiklander     if( ( ret = mbedtls_x509write_csr_der( ctx, output_buf, sizeof(output_buf),
243817466cbSJens Wiklander                                    f_rng, p_rng ) ) < 0 )
244817466cbSJens Wiklander     {
245817466cbSJens Wiklander         return( ret );
246817466cbSJens Wiklander     }
247817466cbSJens Wiklander 
248817466cbSJens Wiklander     if( ( ret = mbedtls_pem_write_buffer( PEM_BEGIN_CSR, PEM_END_CSR,
249817466cbSJens Wiklander                                   output_buf + sizeof(output_buf) - ret,
250817466cbSJens Wiklander                                   ret, buf, size, &olen ) ) != 0 )
251817466cbSJens Wiklander     {
252817466cbSJens Wiklander         return( ret );
253817466cbSJens Wiklander     }
254817466cbSJens Wiklander 
255817466cbSJens Wiklander     return( 0 );
256817466cbSJens Wiklander }
257817466cbSJens Wiklander #endif /* MBEDTLS_PEM_WRITE_C */
258817466cbSJens Wiklander 
259817466cbSJens Wiklander #endif /* MBEDTLS_X509_CSR_WRITE_C */
260