mbed TLS v2.23.0: pem.h Source File

mbed TLS v2.23.0

pem.h
Go to the documentation of this file.
1
6 /*
7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 *
22 * This file is part of mbed TLS (https://tls.mbed.org)
23 */
24 #ifndef MBEDTLS_PEM_H
25 #define MBEDTLS_PEM_H
26
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "mbedtls/config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32
33 #include <stddef.h>
34
41 #define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT -0x1080
42 #define MBEDTLS_ERR_PEM_INVALID_DATA -0x1100
43 #define MBEDTLS_ERR_PEM_ALLOC_FAILED -0x1180
44 #define MBEDTLS_ERR_PEM_INVALID_ENC_IV -0x1200
45 #define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG -0x1280
46 #define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED -0x1300
47 #define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH -0x1380
48 #define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400
49 #define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480
50 /* \} name */
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56 #if defined(MBEDTLS_PEM_PARSE_C)
57
60 typedef struct mbedtls_pem_context
61 {
62 unsigned char *buf;
63 size_t buflen;
64 unsigned char *info;
65 }
66 mbedtls_pem_context;
67
73 void mbedtls_pem_init( mbedtls_pem_context *ctx );
74
97 int mbedtls_pem_read_buffer( mbedtls_pem_context *ctx, const char *header, const char *footer,
98 const unsigned char *data,
99 const unsigned char *pwd,
100 size_t pwdlen, size_t *use_len );
101
107 void mbedtls_pem_free( mbedtls_pem_context *ctx );
108 #endif /* MBEDTLS_PEM_PARSE_C */
109
110 #if defined(MBEDTLS_PEM_WRITE_C)
111
137 int mbedtls_pem_write_buffer( const char *header, const char *footer,
138 const unsigned char *der_data, size_t der_len,
139 unsigned char *buf, size_t buf_len, size_t *olen );
140 #endif /* MBEDTLS_PEM_WRITE_C */
141
142 #ifdef __cplusplus
143 }
144 #endif
145
146 #endif /* pem.h */
mbedtls_pem_context
struct mbedtls_pem_context mbedtls_pem_context
PEM context structure.
mbedtls_pem_read_buffer
int mbedtls_pem_read_buffer(mbedtls_pem_context *ctx, const char *header, const char *footer, const unsigned char *data, const unsigned char *pwd, size_t pwdlen, size_t *use_len)
Read a buffer for PEM information and store the resulting data into the specified context buffers.
mbedtls_pem_free
void mbedtls_pem_free(mbedtls_pem_context *ctx)
PEM context memory freeing.
mbedtls_pem_init
void mbedtls_pem_init(mbedtls_pem_context *ctx)
PEM context setup.
mbedtls_pem_context::buf
unsigned char * buf
Definition: pem.h:62
mbedtls_pem_context::buflen
size_t buflen
Definition: pem.h:63
mbedtls_pem_write_buffer
int mbedtls_pem_write_buffer(const char *header, const char *footer, const unsigned char *der_data, size_t der_len, unsigned char *buf, size_t buf_len, size_t *olen)
Write a buffer of PEM information from a DER encoded buffer.
config.h
Configuration options (set of defines)
mbedtls_pem_context::info
unsigned char * info
Definition: pem.h:64
mbedtls_pem_context
PEM context structure.
Definition: pem.h:61