doc/crypto/ASN1_INTEGER_get_int64.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ASN1_INTEGER_get_int64, ASN1_INTEGER_get, ASN1_INTEGER_set_int64, ASN1_INTEGER_set, BN_to_ASN1_INTEGER, ASN1_INTEGER_to_BN, ASN1_ENUMERATED_get_int64, ASN1_ENUMERATED_get, ASN1_ENUMERATED_set_int64, ASN1_ENUMERATED_set, BN_to_ASN1_ENUMERATED, ASN1_ENUMERATED_to_BN, - ASN.1 INTEGER and ENUMERATED utilities
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/asn1.h>
  10
  11  int ASN1_INTEGER_get_int64(int64_t *pr, const ASN1_INTEGER *a);
  12  int ASN1_INTEGER_get(ASN1_INTEGER *a, long v);
  13
  14  int ASN1_INTEGER_set_int64(ASN1_INTEGER *a, int64_t r);
  15  long ASN1_INTEGER_set(const ASN1_INTEGER *a);
  16
  17  int ASN1_INTEGER_get_uint64(uint64_t *pr, const ASN1_INTEGER *a);
  18  int ASN1_INTEGER_set_uint64(ASN1_INTEGER *a, uint64_t r);
  19
  20  ASN1_INTEGER *BN_to_ASN1_INTEGER(const BIGNUM *bn, ASN1_INTEGER *ai);
  21  BIGNUM *ASN1_INTEGER_to_BN(const ASN1_INTEGER *ai, BIGNUM *bn);
  22
  23  int ASN1_ENUMERATED_get_int64(int64_t *pr, const ASN1_INTEGER *a);
  24  long ASN1_ENUMERATED_get(ASN1_ENUMERATED *a);
  25
  26  int ASN1_ENUMERATED_set_int64(ASN1_INTEGER *a, int64_t r);
  27  int ASN1_ENUMERATED_set(ASN1_ENUMERATED *a, long v);
  28
  29  ASN1_ENUMERATED *BN_to_ASN1_ENUMERATED(BIGNUM *bn, ASN1_ENUMERATED *ai);
  30  BIGNUM *ASN1_ENUMERATED_to_BN(ASN1_ENUMERATED *ai, BIGNUM *bn);
  31
  32 =head1 DESCRIPTION
  33
  34 These functions convert to and from B<ASN1_INTEGER> and B<ASN1_ENUMERATED>
  35 structures.
  36
  37 ASN1_INTEGER_get_int64() converts an B<ASN1_INTEGER> into an B<int64_t> type
  38 If successful it returns 1 and sets B<*pr> to the value of B<a>. If it fails
  39 (due to invalid type or the value being too big to fit into an B<int64_t> type)
  40 it returns 0.
  41
  42 ASN1_INTEGER_get_uint64() is similar to ASN1_INTEGER_get_int64_t() except it
  43 converts to a B<uint64_t> type and an error is returned if the passed integer
  44 is negative.
  45
  46 ASN1_INTEGER_get() also returns the value of B<a> but it returns 0 if B<a> is
  47 NULL and -1 on error (which is ambiguous because -1 is a legitimate value for
  48 an B<ASN1_INTEGER>). New applications should use ASN1_INTEGER_get_int64()
  49 instead.
  50
  51 ASN1_INTEGER_set_int64() sets the value of B<ASN1_INTEGER> B<a> to the
  52 B<int64_t> value B<r>.
  53
  54 ASN1_INTEGER_set_uint64() sets the value of B<ASN1_INTEGER> B<a> to the
  55 B<uint64_t> value B<r>.
  56
  57 ASN1_INTEGER_set() sets the value of B<ASN1_INTEGER> B<a> to the B<long> value
  58 B<v>.
  59
  60 BN_to_ASN1_INTEGER() converts B<BIGNUM> B<bn> to an B<ASN1_INTEGER>. If B<ai>
  61 is NULL a new B<ASN1_INTEGER> structure is returned. If B<ai> is not NULL then
  62 the existing structure will be used instead.
  63
  64 ASN1_INTEGER_to_BN() converts ASN1_INTEGER B<ai> into a B<BIGNUM>. If B<bn> is
  65 NULL a new B<BIGNUM> structure is returned. If B<bn> is not NULL then the
  66 existing structure will be used instead.
  67
  68 ASN1_ENUMERATED_get_int64(), ASN1_ENUMERATED_set_int64(),
  69 ASN1_ENUMERATED_set(), BN_to_ASN1_ENUMERATED() and ASN1_ENUMERATED_to_BN()
  70 behave in an identical way to their ASN1_INTEGER counterparts except they
  71 operate on an B<ASN1_ENUMERATED> value.
  72
  73 ASN1_ENUMERATED_get() returns the value of B<a> in a similar way to
  74 ASN1_INTEGER_get() but it returns B<0xffffffffL> if the value of B<a> will not
  75 fit in a long type. New applications should use ASN1_ENUMERATED_get_int64()
  76 instead.
  77
  78 =head1 NOTES
  79
  80 In general an B<ASN1_INTEGER> or B<ASN1_ENUMERATED> type can contain an
  81 integer of almost arbitrary size and so cannot always be represented by a C
  82 B<int64_t> type. However in many cases (for example version numbers) they
  83 represent small integers which can be more easily manipulated if converted to
  84 an appropriate C integer type.
  85
  86 =head1 BUGS
  87
  88 The ambigious return values of ASN1_INTEGER_get() and ASN1_ENUMERATED_get()
  89 mean these functions should be avoided if possible. They are retained for
  90 compatibility. Normally the ambigious return values are not legitimate
  91 values for the fields they represent.
  92
  93 =head1 RETURN VALUES
  94
  95 ASN1_INTEGER_set_int64(), ASN1_INTEGER_set(), ASN1_ENUMERATED_set_int64() and
  96 ASN1_ENUMERATED_set() return 1 for success and 0 for failure. They will only
  97 fail if a memory allocation error occurs.
  98
  99 ASN1_INTEGER_get_int64() and ASN1_ENUMERATED_get_int64() return 1 for success
 100 and 0 for failure. They will fail if the passed type is incorrect (this will
 101 only happen if there is a programming error) or if the value exceeds the range
 102 of an B<int64_t> type.
 103
 104 BN_to_ASN1_INTEGER() and BN_to_ASN1_ENUMERATED() return an B<ASN1_INTEGER> or
 105 B<ASN1_ENUMERATED> structure respectively or NULL if an error occurs. They will
 106 only fail due to a memory allocation error.
 107
 108 ASN1_INTEGER_to_BN() and ASN1_ENUMERATED_to_BN() return a B<BIGNUM> structure
 109 of NULL if an error occurs. They can fail if the pased type is incorrect
 110 (due to programming error) or due to a memory allocation failure.
 111
 112 =head1 SEE ALSO
 113
 114 L<ERR_get_error(3)>
 115
 116 =head1 HISTORY
 117
 118 ASN1_INTEGER_set_int64(), ASN1_INTEGER_get_int64(),
 119 ASN1_ENUMERATED_set_int64() and ASN1_ENUMERATED_get_int64()
 120 were added to OpenSSL 1.1.0.
 121
 122 =cut