ASN.1 (Abstract Syntax Notation One) More...

#include "core/crypto.h"
#include "encoding/asn1.h"
#include "encoding/oid.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL CRYPTO_TRACE_LEVEL

Functions
error_t	asn1ReadTag (const uint8_t data, size_t length, Asn1Tag tag)
	Read an ASN.1 tag from the input stream. More...

error_t	asn1ReadSequence (const uint8_t data, size_t length, Asn1Tag tag)
	Read an ASN.1 sequence from the input stream. More...

error_t	asn1ReadOctetString (const uint8_t data, size_t length, Asn1Tag tag)
	Read an octet string from the input stream. More...

error_t	asn1ReadOid (const uint8_t data, size_t length, Asn1Tag tag)
	Read an object identifier from the input stream. More...

error_t	asn1ReadBoolean (const uint8_t data, size_t length, Asn1Tag tag, bool_t *value)
	Read a boolean from the input stream. More...

error_t	asn1ReadInt32 (const uint8_t data, size_t length, Asn1Tag tag, int32_t *value)
	Read a 32-bit integer from the input stream. More...

error_t	asn1WriteTag (Asn1Tag tag, bool_t reverse, uint8_t data, size_t *written)
	Write an ASN.1 tag. More...

error_t	asn1WriteInt32 (int32_t value, bool_t reverse, uint8_t data, size_t written)
	Write a 32-bit integer to the output stream. More...

error_t	asn1ReadMpi (const uint8_t data, size_t length, Asn1Tag tag, Mpi *value)
	Read a multiple-precision integer from the input stream. More...

error_t	asn1WriteMpi (const Mpi value, bool_t reverse, uint8_t data, size_t *written)
	Write a multiple-precision integer from the output stream. More...

error_t	asn1CheckTag (const Asn1Tag *tag, bool_t constructed, uint_t objClass, uint_t objType)
	Enforce the type of a specified tag. More...

error_t	asn1CheckOid (const Asn1Tag tag, const uint8_t oid, size_t length)
	Check ASN.1 tag against a specified OID. More...

error_t	asn1DumpObject (const uint8_t *data, size_t length, uint_t level)
	Display an ASN.1 data object. More...

Detailed Description

ASN.1 (Abstract Syntax Notation One)

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneCRYPTO Open.

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.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file asn1.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL CRYPTO_TRACE_LEVEL

Definition at line 32 of file asn1.c.

Function Documentation

◆ asn1CheckOid()

error_t asn1CheckOid	(	const Asn1Tag *	tag,
		const uint8_t *	oid,
		size_t	length
	)

Check ASN.1 tag against a specified OID.

Parameters

[in]	tag	Pointer to an ASN.1 tag
[in]	oid	Expected object identifier (OID)
[in]	length	Length of the OID

Returns: Error code

Definition at line 679 of file asn1.c.

◆ asn1CheckTag()

error_t asn1CheckTag	(	const Asn1Tag *	tag,
		bool_t	constructed,
		uint_t	objClass,
		uint_t	objType
	)

Enforce the type of a specified tag.

Parameters

[in]	tag	Pointer to an ASN.1 tag
[in]	constructed	Expected encoding (TRUE for constructed, FALSE for primitive)
[in]	objClass	Expected tag class
[in]	objType	Expected tag type

Returns: Error code

Definition at line 653 of file asn1.c.

◆ asn1DumpObject()

error_t asn1DumpObject	(	const uint8_t *	data,
		size_t	length,
		uint_t	level
	)

Display an ASN.1 data object.

Parameters

[in]	data	Pointer to the ASN.1 object to dump
[in]	length	Length of the ASN.1 object
[in]	level	Current level of recursion (this parameter shall be set to 0)

Returns: Error code

Definition at line 706 of file asn1.c.

◆ asn1ReadBoolean()

error_t asn1ReadBoolean	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag,
		bool_t *	value
	)

Read a boolean from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag
[out]	value	Boolean value

Returns: Error code

Definition at line 247 of file asn1.c.

◆ asn1ReadInt32()

error_t asn1ReadInt32	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag,
		int32_t *	value
	)

Read a 32-bit integer from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag
[out]	value	Integer value

Returns: Error code

Definition at line 285 of file asn1.c.

◆ asn1ReadMpi()

error_t asn1ReadMpi	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag,
		Mpi *	value
	)

Read a multiple-precision integer from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag
[out]	value	Integer value

Returns: Error code

Definition at line 553 of file asn1.c.

◆ asn1ReadOctetString()

error_t asn1ReadOctetString	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag
	)

Read an octet string from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag

Returns: Error code

Definition at line 190 of file asn1.c.

◆ asn1ReadOid()

error_t asn1ReadOid	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag
	)

Read an object identifier from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag

Returns: Error code

Definition at line 218 of file asn1.c.

◆ asn1ReadSequence()

error_t asn1ReadSequence	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag
	)

Read an ASN.1 sequence from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag

Returns: Error code

Definition at line 163 of file asn1.c.

◆ asn1ReadTag()

error_t asn1ReadTag	(	const uint8_t *	data,
		size_t	length,
		Asn1Tag *	tag
	)

Read an ASN.1 tag from the input stream.

Parameters

[in]	data	Input stream where to read the tag
[in]	length	Number of bytes available in the input stream
[out]	tag	Structure describing the ASN.1 tag

Returns: Error code

Definition at line 52 of file asn1.c.

◆ asn1WriteInt32()

error_t asn1WriteInt32	(	int32_t	value,
		bool_t	reverse,
		uint8_t *	data,
		size_t *	written
	)

Write a 32-bit integer to the output stream.

Parameters

[in]	value	Integer value
[in]	reverse	Use reverse encoding
[out]	data	Output stream where to write the tag (optional parameter)
[out]	written	Number of bytes written to the output stream

Returns: Error code

Definition at line 495 of file asn1.c.

◆ asn1WriteMpi()

error_t asn1WriteMpi	(	const Mpi *	value,
		bool_t	reverse,
		uint8_t *	data,
		size_t *	written
	)

Write a multiple-precision integer from the output stream.

Parameters

[in]	value	Integer value
[in]	reverse	Use reverse encoding
[out]	data	Output stream where to write the tag (optional parameter)
[out]	written	Number of bytes written to the output stream

Returns: Error code

Definition at line 591 of file asn1.c.

◆ asn1WriteTag()

error_t asn1WriteTag	(	Asn1Tag *	tag,
		bool_t	reverse,
		uint8_t *	data,
		size_t *	written
	)

Write an ASN.1 tag.

Parameters

[in]	tag	Structure describing the ASN.1 tag
[in]	reverse	Use reverse encoding
[out]	data	Output stream where to write the tag (optional parameter)
[out]	written	Number of bytes written to the output stream (optional parameter)

Returns: Error code

Definition at line 334 of file asn1.c.

Macros

Functions

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ asn1CheckOid()

◆ asn1CheckTag()

◆ asn1DumpObject()

◆ asn1ReadBoolean()

◆ asn1ReadInt32()

◆ asn1ReadMpi()

◆ asn1ReadOctetString()

◆ asn1ReadOid()

◆ asn1ReadSequence()

◆ asn1ReadTag()

◆ asn1WriteInt32()

◆ asn1WriteMpi()

◆ asn1WriteTag()