Mbed TLS v3.5.0
pem.h
Go to the documentation of this file.
1
6/*
7 * Copyright The Mbed TLS Contributors
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#ifndef MBEDTLS_PEM_H
23#define MBEDTLS_PEM_H
25
26#include "mbedtls/build_info.h"
27
28#include <stddef.h>
29
37#define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT -0x1080
39#define MBEDTLS_ERR_PEM_INVALID_DATA -0x1100
41#define MBEDTLS_ERR_PEM_ALLOC_FAILED -0x1180
43#define MBEDTLS_ERR_PEM_INVALID_ENC_IV -0x1200
45#define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG -0x1280
47#define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED -0x1300
49#define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH -0x1380
51#define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400
53#define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480
56#ifdef __cplusplus
57extern "C" {
58#endif
59
60#if defined(MBEDTLS_PEM_PARSE_C)
64typedef struct mbedtls_pem_context {
65 unsigned char *MBEDTLS_PRIVATE(buf);
66 size_t MBEDTLS_PRIVATE(buflen);
67 unsigned char *MBEDTLS_PRIVATE(info);
68}
70
77
104int mbedtls_pem_read_buffer(mbedtls_pem_context *ctx, const char *header, const char *footer,
105 const unsigned char *data,
106 const unsigned char *pwd,
107 size_t pwdlen, size_t *use_len);
108
121static inline const unsigned char *mbedtls_pem_get_buffer(mbedtls_pem_context *ctx, size_t *buflen)
122{
123 *buflen = ctx->MBEDTLS_PRIVATE(buflen);
124 return ctx->MBEDTLS_PRIVATE(buf);
125}
126
127
134#endif /* MBEDTLS_PEM_PARSE_C */
135
136#if defined(MBEDTLS_PEM_WRITE_C)
163int mbedtls_pem_write_buffer(const char *header, const char *footer,
164 const unsigned char *der_data, size_t der_len,
165 unsigned char *buf, size_t buf_len, size_t *olen);
166#endif /* MBEDTLS_PEM_WRITE_C */
167
168#ifdef __cplusplus
169}
170#endif
171
172#endif /* pem.h */
Build-time configuration info.
void mbedtls_pem_init(mbedtls_pem_context *ctx)
PEM context setup.
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.
static const unsigned char * mbedtls_pem_get_buffer(mbedtls_pem_context *ctx, size_t *buflen)
Get the pointer to the decoded binary data in a PEM context.
Definition: pem.h:121
struct mbedtls_pem_context mbedtls_pem_context
PEM context structure.
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_free(mbedtls_pem_context *ctx)
PEM context memory freeing.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
PEM context structure.
Definition: pem.h:64