doc/crypto/X509_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_new, X509_free, X509_up_ref - X509 certificate ASN1 allocation functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/x509.h>
  10
  11  X509 *X509_new(void);
  12  void X509_free(X509 *a);
  13  void X509_up_ref(X509 *a);
  14
  15 =head1 DESCRIPTION
  16
  17 The X509 ASN1 allocation routines, allocate and free an
  18 X509 structure, which represents an X509 certificate.
  19
  20 X509_new() allocates and initializes a X509 structure with reference count
  21 B<1>.
  22
  23 X509_free() decrements the reference count of B<X509> structure B<a> and
  24 frees it up if the reference count is zero. If B<a> is NULL nothing is done.
  25
  26 X509_up_ref() increments the reference count of B<a>.
  27
  28 =head1 NOTES
  29
  30 The function X509_up_ref() if useful if a certificate structure is being
  31 used by several different operations each of which will free it up after
  32 use: this avoids the need to duplicate the entire certificate structure.
  33
  34 =head1 RETURN VALUES
  35
  36 If the allocation fails, X509_new() returns B<NULL> and sets an error
  37 code that can be obtained by L<ERR_get_error(3)>.
  38 Otherwise it returns a pointer to the newly allocated structure.
  39
  40 X509_free() and X509_up_ref() do not return a value.
  41
  42 =head1 SEE ALSO
  43
  44 L<d2i_X509(3)>,
  45 L<ERR_get_error(3)>,
  46 L<X509_CRL_get0_by_serial(3)>,
  47 L<X509_get0_signature(3)>,
  48 L<X509_get_ext_d2i(3)>,
  49 L<X509_get_extension_flags(3)>,
  50 L<X509_get_pubkey(3)>,
  51 L<X509_get_subject_name(3)>,
  52 L<X509_get_version(3)>,
  53 L<X509_NAME_add_entry_by_txt(3)>,
  54 L<X509_NAME_ENTRY_get_object(3)>,
  55 L<X509_NAME_get_index_by_NID(3)>,
  56 L<X509_NAME_print_ex(3)>,
  57 L<X509_sign(3)>,
  58 L<X509V3_get_d2i(3)>,
  59 L<X509_verify_cert(3)>
  60
  61 =cut