crypto/openssl-0.9.7e/doc/crypto/ASN1_STRING_length.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length,
   6 ASN1_STRING_length_set, ASN1_STRING_type, ASN1_STRING_data -
   7 ASN1_STRING utility functions
   8
   9 =head1 SYNOPSIS
  10
  11  int ASN1_STRING_length(ASN1_STRING *x);
  12  unsigned char * ASN1_STRING_data(ASN1_STRING *x);
  13
  14  ASN1_STRING * ASN1_STRING_dup(ASN1_STRING *a);
  15
  16  int ASN1_STRING_cmp(ASN1_STRING *a, ASN1_STRING *b);
  17
  18  int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len);
  19
  20  int ASN1_STRING_type(ASN1_STRING *x);
  21
  22  int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in);
  23
  24 =head1 DESCRIPTION
  25
  26 These functions allow an B<ASN1_STRING> structure to be manipulated.
  27
  28 ASN1_STRING_length() returns the length of the content of B<x>.
  29
  30 ASN1_STRING_data() returns an internal pointer to the data of B<x>.
  31 Since this is an internal pointer it should B<not> be freed or
  32 modified in any way.
  33
  34 ASN1_STRING_dup() returns a copy of the structure B<a>.
  35
  36 ASN1_STRING_cmp() compares B<a> and B<b> returning 0 if the two
  37 are identical. The string types and content are compared.
  38
  39 ASN1_STRING_set() sets the data of string B<str> to the buffer
  40 B<data> or length B<len>. The supplied data is copied. If B<len>
  41 is -1 then the length is determined by strlen(data).
  42
  43 ASN1_STRING_type() returns the type of B<x>, using standard constants
  44 such as B<V_ASN1_OCTET_STRING>.
  45
  46 ASN1_STRING_to_UTF8() converts the string B<in> to UTF8 format, the
  47 converted data is allocated in a buffer in B<*out>. The length of
  48 B<out> is returned or a negative error code. The buffer B<*out>
  49 should be free using OPENSSL_free().
  50
  51 =head1 NOTES
  52
  53 Almost all ASN1 types in OpenSSL are represented as an B<ASN1_STRING>
  54 structure. Other types such as B<ASN1_OCTET_STRING> are simply typedefed
  55 to B<ASN1_STRING> and the functions call the B<ASN1_STRING> equivalents.
  56 B<ASN1_STRING> is also used for some B<CHOICE> types which consist
  57 entirely of primitive string types such as B<DirectoryString> and
  58 B<Time>.
  59
  60 These functions should B<not> be used to examine or modify B<ASN1_INTEGER>
  61 or B<ASN1_ENUMERATED> types: the relevant B<INTEGER> or B<ENUMERATED>
  62 utility functions should be used instead.
  63
  64 In general it cannot be assumed that the data returned by ASN1_STRING_data()
  65 is null terminated or does not contain embedded nulls. The actual format
  66 of the data will depend on the actual string type itself: for example
  67 for and IA5String the data will be ASCII, for a BMPString two bytes per
  68 character in big endian format, UTF8String will be in UTF8 format.
  69
  70 Similar care should be take to ensure the data is in the correct format
  71 when calling ASN1_STRING_set().
  72
  73 =head1 RETURN VALUES
  74
  75 =head1 SEE ALSO
  76
  77 L<ERR_get_error(3)|ERR_get_error(3)>
  78
  79 =head1 HISTORY
  80
  81 =cut