ASN1_STRING_length¶
NAME¶
ASN1_STRING_get0_data, ASN1_STRING_copy, ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_type, ASN1_STRING_to_UTF8, ASN1_STRING_set1_data, ASN1_STRING_set1_string, ASN1_STRING_set0, ASN1_STRING_get_length, ASN1_STRING_set, ASN1_STRING_length, ASN1_STRING_length_set - ASN1_STRING utility functions
SYNOPSIS¶
#include <openssl/asn1.h>
const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x);
int ASN1_STRING_copy(ASN1_STRING *dst, const ASN1_STRING *str);
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_set1_data(ASN1_STRING *str, const uint8_t *data, size_t len);
int ASN1_STRING_set1_string(ASN1_STRING *str, const char *data);
void ASN1_STRING_set0(ASN1_STRING *str, void *data, int len);
size_t ASN1_STRING_get_length(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);
The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros(7):
void ASN1_STRING_length_set(ASN1_STRING *x, int n);
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_get_length() returns the length of the content of x. x MUST NOT be NULL. If the current length of the content of x cannot be represented by a value of type size_t (for example, after an ASN1_STRING_length_set() call with a negative n argument), 0 is returned.
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_copy() copies the string type and content (along with the relevant internal attributes) from str to dst.
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). As a historic implementation detail, ASN1_STRING_set() appends a NUL byte after the data copied into str, so this function is deprecated.
ASN1_STRING_set1_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. Unlike ASN1_STRING_set(), ASN1_STRING_set1_data() does not append a NUL byte to the data copied into str.
ASN1_STRING_set1_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_set1_string() does not append a NUL byte to the data copied into str.
ASN1_STRING_set0() sets the content of the string str to data of len bytes in size; the ownership of data is assumed by the string (consequently, data must be allocated using OPENSSL_malloc() function, and the caller should not attempt to free data after the call). The previously held content (in case they were owned by the string) is freed using OPENSSL_clear_free(), provided the length of the content is positive. str must not be NULL. If data is NULL, len must be 0. A negative len value is treated as 0. Note that ASN1_STRING_set0() does not reset the unused bits field, used by ASN1_BIT_STRING (contrary to what ASN1_STRING_set(), ASN1_STRING_set1_data(), and ASN1_STRING_set1_string() do), so it is not suitable for this type of 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 buffer is NUL terminated, so it is a valid C string, but the returned length does not include the terminating NUL. The length of out is returned or a negative error code. The buffer *out should be freed using OPENSSL_free(). See "WARNINGS" below.
ASN1_STRING_length_set() allows setting the length of x to an arbitrary value provided in n.
NOTES¶
Almost all ASN.1 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 NUL-terminated or does not contain embedded NUL bytes. 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, it will be two bytes per character in big endian format without BOM; and for a UTF8String, it will be encoded in UTF-8.
Similar care should be taken to ensure the data is in the correct format when calling ASN1_STRING_set(), ASN1_STRING_set1_data(), or ASN1_STRING_set1_string().
ASN1_STRING_length_set() updates only the length attribute of a string and does not affect the stored data, which may lead to buffer overruns and invalid memory accesses, if an incorrect length value is supplied. It also does not perform any sanity checks and stores any supplied value as-is, including a negative one. For these reasons (and due to limited usefulness), this function is deprecated and should not be used.
WARNINGS¶
Although the buffer returned by ASN1_STRING_to_UTF8() is NUL terminated and is therefore a valid C string, the converted data may itself contain embedded NUL bytes. Using C string functions such as strlen() or strcmp() on the output is therefore inherently dangerous: they will stop at the first embedded NUL and silently process only part of the string, which can lead to incorrect comparisons or truncated data. Callers should use the returned length and not rely on NUL termination.
RETURN VALUES¶
ASN1_STRING_length() returns the length of the content of x.
ASN1_STRING_get_length() returns the length of the content of x or 0, if it cannot be represented as a value of type size_t.
ASN1_STRING_get0_data() returns an internal pointer to the data of x.
ASN1_STRING_copy() returns 1 on success, or 0 on error or failure. If the call was not successful, dst may be left in an inconsistent state, and can no longer be used.
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_set1_data(), and ASN1_STRING_set1_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.
ASN1_STRING_set0() and ASN1_STRING_length_set() do not return a value.
SEE ALSO¶
HISTORY¶
ASN1_STRING_length_set() was deprecated in OpenSSL 3.0.
ASN1_STRING_set1_data(), ASN1_STRING_set1_string(), and ASN1_STRING_get_length() were added in OpenSSL 4.1.
ASN1_STRING_length() and ASN1_STRING_set() were deprecated in OpenSSL 4.1.
Before OpenSSL 4.1, ASN1_STRING_set0() used OPENSSL_free() instead of OPENSSL_clean_free() to free previously held string content.
COPYRIGHT¶
Copyright 2002-2026 The OpenSSL Project Authors. All Rights Reserved.
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.