| /** |
| * \file asn1write.h |
| * |
| * \brief ASN.1 buffer writing functionality |
| */ |
| /* |
| * Copyright The Mbed TLS Contributors |
| * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| * |
| * This file is provided under the Apache License 2.0, or the |
| * GNU General Public License v2.0 or later. |
| * |
| * ********** |
| * Apache License 2.0: |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| * not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| * |
| * ********** |
| * |
| * ********** |
| * GNU General Public License v2.0 or later: |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of the GNU General Public License as published by |
| * the Free Software Foundation; either version 2 of the License, or |
| * (at your option) any later version. |
| * |
| * This program is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| * GNU General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License along |
| * with this program; if not, write to the Free Software Foundation, Inc., |
| * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * ********** |
| */ |
| #ifndef MBEDTLS_ASN1_WRITE_H |
| #define MBEDTLS_ASN1_WRITE_H |
| |
| #if !defined(MBEDTLS_CONFIG_FILE) |
| #include "config.h" |
| #else |
| #include MBEDTLS_CONFIG_FILE |
| #endif |
| |
| #include "asn1.h" |
| |
| #define MBEDTLS_ASN1_CHK_ADD(g, f) do { if( ( ret = f ) < 0 ) return( ret ); else \ |
| g += ret; } while( 0 ) |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** |
| * \brief Write a length field in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param len the length to write |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_len( unsigned char **p, unsigned char *start, size_t len ); |
| |
| /** |
| * \brief Write a ASN.1 tag in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param tag the tag to write |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_tag( unsigned char **p, unsigned char *start, |
| unsigned char tag ); |
| |
| /** |
| * \brief Write raw buffer data |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param buf data buffer to write |
| * \param size length of the data buffer |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_raw_buffer( unsigned char **p, unsigned char *start, |
| const unsigned char *buf, size_t size ); |
| |
| #if defined(MBEDTLS_BIGNUM_C) |
| /** |
| * \brief Write a big number (MBEDTLS_ASN1_INTEGER) in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param X the MPI to write |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_mpi( unsigned char **p, unsigned char *start, const mbedtls_mpi *X ); |
| #endif /* MBEDTLS_BIGNUM_C */ |
| |
| /** |
| * \brief Write a NULL tag (MBEDTLS_ASN1_NULL) with zero data in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_null( unsigned char **p, unsigned char *start ); |
| |
| /** |
| * \brief Write an OID tag (MBEDTLS_ASN1_OID) and data in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param oid the OID to write |
| * \param oid_len length of the OID |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_oid( unsigned char **p, unsigned char *start, |
| const char *oid, size_t oid_len ); |
| |
| /** |
| * \brief Write an AlgorithmIdentifier sequence in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param oid the OID of the algorithm |
| * \param oid_len length of the OID |
| * \param par_len length of parameters, which must be already written. |
| * If 0, NULL parameters are added |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_algorithm_identifier( unsigned char **p, unsigned char *start, |
| const char *oid, size_t oid_len, |
| size_t par_len ); |
| |
| /** |
| * \brief Write a boolean tag (MBEDTLS_ASN1_BOOLEAN) and value in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param boolean 0 or 1 |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_bool( unsigned char **p, unsigned char *start, int boolean ); |
| |
| /** |
| * \brief Write an int tag (MBEDTLS_ASN1_INTEGER) and value in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param val the integer value |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_int( unsigned char **p, unsigned char *start, int val ); |
| |
| /** |
| * \brief Write a printable string tag (MBEDTLS_ASN1_PRINTABLE_STRING) and |
| * value in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param text the text to write |
| * \param text_len length of the text |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_printable_string( unsigned char **p, unsigned char *start, |
| const char *text, size_t text_len ); |
| |
| /** |
| * \brief Write an IA5 string tag (MBEDTLS_ASN1_IA5_STRING) and |
| * value in ASN.1 format |
| * Note: function works backwards in data buffer |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param text the text to write |
| * \param text_len length of the text |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_ia5_string( unsigned char **p, unsigned char *start, |
| const char *text, size_t text_len ); |
| |
| /** |
| * \brief Write a bitstring tag (#MBEDTLS_ASN1_BIT_STRING) and |
| * value in ASN.1 format. |
| * |
| * \note This function works backwards in data buffer. |
| * |
| * \param p The reference to the current position pointer. |
| * \param start The start of the buffer, for bounds-checking. |
| * \param buf The bitstring to write. |
| * \param bits The total number of bits in the bitstring. |
| * |
| * \return The number of bytes written to \p p on success. |
| * \return A negative error code on failure. |
| */ |
| int mbedtls_asn1_write_bitstring( unsigned char **p, unsigned char *start, |
| const unsigned char *buf, size_t bits ); |
| |
| /** |
| * \brief Write an octet string tag (#MBEDTLS_ASN1_OCTET_STRING) |
| * and value in ASN.1 format. |
| * |
| * \note This function works backwards in data buffer. |
| * |
| * \param p reference to current position pointer |
| * \param start start of the buffer (for bounds-checking) |
| * \param buf data buffer to write |
| * \param size length of the data buffer |
| * |
| * \return the length written or a negative error code |
| */ |
| int mbedtls_asn1_write_octet_string( unsigned char **p, unsigned char *start, |
| const unsigned char *buf, size_t size ); |
| |
| /** |
| * \brief Create or find a specific named_data entry for writing in a |
| * sequence or list based on the OID. If not already in there, |
| * a new entry is added to the head of the list. |
| * Warning: Destructive behaviour for the val data! |
| * |
| * \param list Pointer to the location of the head of the list to seek |
| * through (will be updated in case of a new entry) |
| * \param oid The OID to look for |
| * \param oid_len Size of the OID |
| * \param val Data to store (can be NULL if you want to fill it by hand) |
| * \param val_len Minimum length of the data buffer needed |
| * |
| * \return NULL if if there was a memory allocation error, or a pointer |
| * to the new / existing entry. |
| */ |
| mbedtls_asn1_named_data *mbedtls_asn1_store_named_data( mbedtls_asn1_named_data **list, |
| const char *oid, size_t oid_len, |
| const unsigned char *val, |
| size_t val_len ); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* MBEDTLS_ASN1_WRITE_H */ |
