doc/man3/s2i_ASN1_IA5STRING.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 i2s_ASN1_IA5STRING,
   6 s2i_ASN1_IA5STRING,
   7 i2s_ASN1_INTEGER,
   8 s2i_ASN1_INTEGER,
   9 i2s_ASN1_OCTET_STRING,
  10 s2i_ASN1_OCTET_STRING,
  11 i2s_ASN1_ENUMERATED,
  12 i2s_ASN1_ENUMERATED_TABLE,
  13 - convert objects from/to ASN.1/string representation
  14
  15 =head1 SYNOPSIS
  16
  17 =for openssl generic
  18
  19  char *i2s_ASN1_IA5STRING(X509V3_EXT_METHOD *method, ASN1_IA5STRING *ia5);
  20  ASN1_IA5STRING *s2i_ASN1_IA5STRING(X509V3_EXT_METHOD *method,
  21                                    X509V3_CTX *ctx, const char *str);
  22  char *i2s_ASN1_INTEGER(X509V3_EXT_METHOD *method, const ASN1_INTEGER *a);
  23  ASN1_INTEGER *s2i_ASN1_INTEGER(X509V3_EXT_METHOD *method, const char *value);
  24  char *i2s_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method,
  25                             const ASN1_OCTET_STRING *oct);
  26  ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method,
  27                                          X509V3_CTX *ctx, const char *str);
  28  char *i2s_ASN1_ENUMERATED(X509V3_EXT_METHOD *method, const ASN1_ENUMERATED *a);
  29  char *i2s_ASN1_ENUMERATED_TABLE(X509V3_EXT_METHOD *method,
  30                                 const ASN1_ENUMERATED *e);
  31
  32 =head1 DESCRIPTION
  33
  34 These functions convert OpenSSL objects to and from their ASN.1/string
  35 representation. This function is used for B<X509v3> extensions.
  36
  37 =head1 NOTES
  38
  39 The letters B<i> and B<s> in B<i2s_ASN1_IA5STRING>() stand for
  40 "internal" (that is, an internal C structure) and string respectively.
  41 So B<i2s_ASN1_IA5STRING>() converts from internal to string.
  42
  43 It is the caller's responsibility to free the returned string.
  44 In the B<i2s_ASN1_IA5STRING>() function the string is copied and
  45 the ownership of the original string remains with the caller.
  46
  47 =head1 RETURN VALUES
  48
  49 B<i2s_ASN1_IA5STRING>() returns the pointer to a IA5 string
  50 or NULL if an error occurs.
  51
  52 B<s2i_ASN1_IA5STRING>() return a valid
  53 B<ASN1_IA5STRING> structure or NULL if an error occurs.
  54
  55 B<i2s_ASN1_INTEGER>() return a valid
  56 string or NULL if an error occurs.
  57
  58 B<s2i_ASN1_INTEGER>() returns the pointer to a B<ASN1_INTEGER>
  59 structure or NULL if an error occurs.
  60
  61 B<i2s_ASN1_OCTET_STRING>() returns the pointer to a OCTET_STRING string
  62 or NULL if an error occurs.
  63
  64 B<s2i_ASN1_OCTET_STRING>() return a valid
  65 B<ASN1_OCTET_STRING> structure or NULL if an error occurs.
  66
  67 B<i2s_ASN1_ENUMERATED>() return a valid
  68 string or NULL if an error occurs.
  69
  70 B<s2i_ASN1_ENUMERATED>() returns the pointer to a B<ASN1_ENUMERATED>
  71 structure or NULL if an error occurs.
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  76
  77 Licensed under the Apache License 2.0 (the "License").  You may not use
  78 this file except in compliance with the License.  You can obtain a copy
  79 in the file LICENSE in the source distribution or at
  80 L<https://www.openssl.org/source/license.html>.
  81
  82 =cut