diff options
Diffstat (limited to 'deps/openssl/openssl/doc/crypto/ASN1_STRING_length.pod')
| -rw-r--r-- | deps/openssl/openssl/doc/crypto/ASN1_STRING_length.pod | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/deps/openssl/openssl/doc/crypto/ASN1_STRING_length.pod b/deps/openssl/openssl/doc/crypto/ASN1_STRING_length.pod index 4ea6e8c226..20a372dc12 100644 --- a/deps/openssl/openssl/doc/crypto/ASN1_STRING_length.pod +++ b/deps/openssl/openssl/doc/crypto/ASN1_STRING_length.pod @@ -3,14 +3,15 @@ =head1 NAME ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length, -ASN1_STRING_length_set, ASN1_STRING_type, ASN1_STRING_data, ASN1_STRING_to_UTF8 - -ASN1_STRING utility functions +ASN1_STRING_type, ASN1_STRING_get0_data, ASN1_STRING_data, +ASN1_STRING_to_UTF8 - ASN1_STRING utility functions =head1 SYNOPSIS #include <openssl/asn1.h> int ASN1_STRING_length(ASN1_STRING *x); + const unsigned char * ASN1_STRING_get0_data(const ASN1_STRING *x); unsigned char * ASN1_STRING_data(ASN1_STRING *x); ASN1_STRING * ASN1_STRING_dup(ASN1_STRING *a); @@ -19,9 +20,9 @@ ASN1_STRING utility functions int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len); - int ASN1_STRING_type(ASN1_STRING *x); + int ASN1_STRING_type(const ASN1_STRING *x); - int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in); + int ASN1_STRING_to_UTF8(unsigned char **out, const ASN1_STRING *in); =head1 DESCRIPTION @@ -29,10 +30,14 @@ These functions allow an B<ASN1_STRING> structure to be manipulated. ASN1_STRING_length() returns the length of the content of B<x>. -ASN1_STRING_data() returns an internal pointer to the data of B<x>. +ASN1_STRING_get0_data() returns an internal pointer to the data of B<x>. Since this is an internal pointer it should B<not> be freed or modified in any way. +ASN1_STRING_data() is similar to ASN1_STRING_get0_data() except the +returned value is not constant. This function is deprecated: +applications should use ASN1_STRING_get0_data() instead. + ASN1_STRING_dup() returns a copy of the structure B<a>. ASN1_STRING_cmp() compares B<a> and B<b> returning 0 if the two @@ -48,12 +53,12 @@ such as B<V_ASN1_OCTET_STRING>. ASN1_STRING_to_UTF8() converts the string B<in> to UTF8 format, the converted data is allocated in a buffer in B<*out>. The length of B<out> is returned or a negative error code. The buffer B<*out> -should be free using OPENSSL_free(). +should be freed using OPENSSL_free(). =head1 NOTES Almost all ASN1 types in OpenSSL are represented as an B<ASN1_STRING> -structure. Other types such as B<ASN1_OCTET_STRING> are simply typedefed +structure. Other types such as B<ASN1_OCTET_STRING> are simply typedef'ed to B<ASN1_STRING> and the functions call the B<ASN1_STRING> equivalents. B<ASN1_STRING> is also used for some B<CHOICE> types which consist entirely of primitive string types such as B<DirectoryString> and @@ -72,12 +77,17 @@ character in big endian format, and for an UTF8String it will be in UTF8 format. Similar care should be take to ensure the data is in the correct format when calling ASN1_STRING_set(). -=head1 RETURN VALUES - =head1 SEE ALSO -L<ERR_get_error(3)|ERR_get_error(3)> +L<ERR_get_error(3)> + +=head1 COPYRIGHT + +Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved. -=head1 HISTORY +Licensed under the OpenSSL license (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 +L<https://www.openssl.org/source/license.html>. =cut |