ASN1_STRING_length¶

NAME¶

ASN1_STRING_set_data, ASN1_STRING_set_string, ASN1_STRING_length_ex, ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length, ASN1_STRING_type, ASN1_STRING_get0_data, ASN1_STRING_to_UTF8 - ASN1_STRING utility functions

SYNOPSIS¶

#include <openssl/asn1.h>

const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x);

ASN1_STRING *ASN1_STRING_dup(const ASN1_STRING *a);

int ASN1_STRING_cmp(ASN1_STRING *a, ASN1_STRING *b);

int ASN1_STRING_type(const ASN1_STRING *x);

int ASN1_STRING_to_UTF8(unsigned char **out, const ASN1_STRING *in);

int ASN1_STRING_set_data(ASN1_STRING *str, const uint8_t *data, size_t len);

int ASN1_STRING_set_string(ASN1_STRING *str, const char *data);

size_t ASN1_STRING_length_ex(const ASN1_STRING *x);

The following functions have been deprecated since OpenSSL 4.1, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros(7):

int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len);

int ASN1_STRING_length(ASN1_STRING *x);

DESCRIPTION¶

These functions allow an ASN1_STRING structure to be manipulated.

ASN1_STRING_length() returns the length of the content of x. x MUST NOT be NULL.

ASN1_STRING_get0_data() returns an internal pointer to the data of x. Since this is an internal pointer it should not be freed or modified in any way. x MUST NOT be NULL.

ASN1_STRING_dup() returns a copy of the structure a.

ASN1_STRING_cmp() compares a and b returning 0 if the two are identical. The string types and content are compared.

ASN1_STRING_set() allocates memory for string str to hold len bytes of data. Any previously allocated memory owned by str will be freed or re-used. If data is not NULL, len bytes are copied from the memory pointed to by data to str. If len is -1 then the length is determined by strlen(data).

ASN1_STRING_set_data() allocates memory for string str to hold len bytes of data. Any previously allocated memory owned by str will be freed or re-used. If data is not NULL, len bytes are copied from the memory pointed to by data to str. It is an error to use this function on a string of type ASN1_BIT_STRING.

ASN1_STRING_set_string() allocates memory for the string str and makes a copy of the characters from cstring. Any previously allocated memory owned by str will be freed or re-used. cstring must point to a valid NUL-terminated C string, and must not be NULL. The terminating NUL byte is not included in the data copied into str. It is an error to use this function on a string of type ASN1_BIT_STRING.

ASN1_STRING_type() returns the type of x, using standard constants such as V_ASN1_OCTET_STRING.

ASN1_STRING_to_UTF8() converts the string in to UTF8 format, the converted data is allocated in a buffer in *out. The length of out is returned or a negative error code. The buffer *out should be freed using OPENSSL_free().

NOTES¶

Almost all ASN1 types in OpenSSL are represented as an ASN1_STRING structure. Other types such as ASN1_OCTET_STRING are simply typedef'ed to ASN1_STRING and the functions call the ASN1_STRING equivalents. ASN1_STRING is also used for some CHOICE types which consist entirely of primitive string types such as DirectoryString and Time.

These functions should not be used to examine or modify ASN1_INTEGER or ASN1_ENUMERATED types: the relevant INTEGER or ENUMERATED utility functions should be used instead.

In general it cannot be assumed that the data returned by ASN1_STRING_get0_data() is null terminated or does not contain embedded nulls. The actual format of the data will depend on the actual string type itself: for example for an IA5String the data will be ASCII, for a BMPString two bytes per character in big endian format, and for a UTF8String it will be in UTF8 format.

Similar care should be taken to ensure the data is in the correct format when calling ASN1_STRING_set(), ASN1_STRING_set_data(), or ASN1_STRING_set_string().

RETURN VALUES¶

ASN1_STRING_length() returns the length of the content of x.

ASN1_STRING_get0_data() returns an internal pointer to the data of x.

ASN1_STRING_dup() returns a valid ASN1_STRING structure or NULL if an error occurred.

ASN1_STRING_cmp() returns an integer greater than, equal to, or less than 0, according to whether a is greater than, equal to, or less than b.

ASN1_STRING_set(), ASN1_STRING_set_data(), and ASN1_STRING_set_string() return 1 on success or 0 on error or failure.

ASN1_STRING_type() returns the type of x.

ASN1_STRING_to_UTF8() returns the number of bytes in output string out or a negative value if an error occurred.

HISTORY¶

ASN1_STRING_set_data(), ASN1_STRING_set_string(), and ASN1_STRING_length_ex() were added in OpenSSL 4.1.

COPYRIGHT¶

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at https://www.openssl.org/source/license.html.