mbed TLS v2.16.12
pem.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_PEM_H
50 #define MBEDTLS_PEM_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include <stddef.h>
59 
67 #define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT -0x1080
68 
69 #define MBEDTLS_ERR_PEM_INVALID_DATA -0x1100
70 
71 #define MBEDTLS_ERR_PEM_ALLOC_FAILED -0x1180
72 
73 #define MBEDTLS_ERR_PEM_INVALID_ENC_IV -0x1200
74 
75 #define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG -0x1280
76 
77 #define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED -0x1300
78 
79 #define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH -0x1380
80 
81 #define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400
82 
83 #define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480
84 /* \} name */
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
90 #if defined(MBEDTLS_PEM_PARSE_C)
91 
94 typedef struct mbedtls_pem_context
95 {
96  unsigned char *buf;
97  size_t buflen;
98  unsigned char *info;
99 }
101 
108 
131 int mbedtls_pem_read_buffer( mbedtls_pem_context *ctx, const char *header, const char *footer,
132  const unsigned char *data,
133  const unsigned char *pwd,
134  size_t pwdlen, size_t *use_len );
135 
142 #endif /* MBEDTLS_PEM_PARSE_C */
143 
144 #if defined(MBEDTLS_PEM_WRITE_C)
145 
171 int mbedtls_pem_write_buffer( const char *header, const char *footer,
172  const unsigned char *der_data, size_t der_len,
173  unsigned char *buf, size_t buf_len, size_t *olen );
174 #endif /* MBEDTLS_PEM_WRITE_C */
175 
176 #ifdef __cplusplus
177 }
178 #endif
179 
180 #endif /* pem.h */
unsigned char * info
Definition: pem.h:98
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.
Configuration options (set of defines)
struct mbedtls_pem_context mbedtls_pem_context
PEM context structure.
PEM context structure.
Definition: pem.h:94
void mbedtls_pem_free(mbedtls_pem_context *ctx)
PEM context memory freeing.
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...
void mbedtls_pem_init(mbedtls_pem_context *ctx)
PEM context setup.
unsigned char * buf
Definition: pem.h:96
size_t buflen
Definition: pem.h:97