crypto/heimdal/doc/doxyout/hcrypto/man/man3/hcrypto_rsa.3

   1 .TH "RSA functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdal crypto library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 RSA functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "RSA * \fBRSA_new\fP (void)"
  11 .br
  12 .ti -1c
  13 .RI "RSA * \fBRSA_new_method\fP (ENGINE *engine)"
  14 .br
  15 .ti -1c
  16 .RI "void \fBRSA_free\fP (RSA *rsa)"
  17 .br
  18 .ti -1c
  19 .RI "int \fBRSA_up_ref\fP (RSA *rsa)"
  20 .br
  21 .ti -1c
  22 .RI "const RSA_METHOD * \fBRSA_get_method\fP (const RSA *rsa)"
  23 .br
  24 .ti -1c
  25 .RI "int \fBRSA_set_method\fP (RSA *rsa, const RSA_METHOD *method)"
  26 .br
  27 .ti -1c
  28 .RI "int \fBRSA_set_app_data\fP (RSA *rsa, void *arg)"
  29 .br
  30 .ti -1c
  31 .RI "void * \fBRSA_get_app_data\fP (const RSA *rsa)"
  32 .br
  33 .in -1c
  34 .SH "Detailed Description"
  35 .PP
  36 See the \fBRSA - public-key cryptography\fP for description and examples.
  37 .SH "Function Documentation"
  38 .PP
  39 .SS "void RSA_free (RSA * rsa)"
  40 .PP
  41 Free an allocation RSA object.
  42 .PP
  43 \fBParameters:\fP
  44 .RS 4
  45 \fIrsa\fP the RSA object to free.
  46 .RE
  47 .PP
  48
  49 .SS "void* RSA_get_app_data (const RSA * rsa)"
  50 .PP
  51 Get the application data for the RSA object.
  52 .PP
  53 \fBParameters:\fP
  54 .RS 4
  55 \fIrsa\fP the rsa object to get the parameter for
  56 .RE
  57 .PP
  58 \fBReturns:\fP
  59 .RS 4
  60 the data object
  61 .RE
  62 .PP
  63
  64 .SS "const RSA_METHOD* RSA_get_method (const RSA * rsa)"
  65 .PP
  66 Return the RSA_METHOD used for this RSA object.
  67 .PP
  68 \fBParameters:\fP
  69 .RS 4
  70 \fIrsa\fP the object to get the method from.
  71 .RE
  72 .PP
  73 \fBReturns:\fP
  74 .RS 4
  75 the method used for this RSA object.
  76 .RE
  77 .PP
  78
  79 .SS "RSA* RSA_new (void)"
  80 .PP
  81 Same as \fBRSA_new_method()\fP using NULL as engine.
  82 .PP
  83 \fBReturns:\fP
  84 .RS 4
  85 a newly allocated RSA object. Free with \fBRSA_free()\fP.
  86 .RE
  87 .PP
  88
  89 .SS "RSA* RSA_new_method (ENGINE * engine)"
  90 .PP
  91 Allocate a new RSA object using the engine, if NULL is specified as the engine, use the default RSA engine as returned by ENGINE_get_default_RSA().
  92 .PP
  93 \fBParameters:\fP
  94 .RS 4
  95 \fIengine\fP Specific what ENGINE RSA provider should be used.
  96 .RE
  97 .PP
  98 \fBReturns:\fP
  99 .RS 4
 100 a newly allocated RSA object. Free with \fBRSA_free()\fP.
 101 .RE
 102 .PP
 103
 104 .SS "int RSA_set_app_data (RSA * rsa, void * arg)"
 105 .PP
 106 Set the application data for the RSA object.
 107 .PP
 108 \fBParameters:\fP
 109 .RS 4
 110 \fIrsa\fP the rsa object to set the parameter for
 111 .br
 112 \fIarg\fP the data object to store
 113 .RE
 114 .PP
 115 \fBReturns:\fP
 116 .RS 4
 117 1 on success.
 118 .RE
 119 .PP
 120
 121 .SS "int RSA_set_method (RSA * rsa, const RSA_METHOD * method)"
 122 .PP
 123 Set a new method for the RSA keypair.
 124 .PP
 125 \fBParameters:\fP
 126 .RS 4
 127 \fIrsa\fP rsa parameter.
 128 .br
 129 \fImethod\fP the new method for the RSA parameter.
 130 .RE
 131 .PP
 132 \fBReturns:\fP
 133 .RS 4
 134 1 on success.
 135 .RE
 136 .PP
 137
 138 .SS "int RSA_up_ref (RSA * rsa)"
 139 .PP
 140 Add an extra reference to the RSA object. The object should be free with \fBRSA_free()\fP to drop the reference.
 141 .PP
 142 \fBParameters:\fP
 143 .RS 4
 144 \fIrsa\fP the object to add reference counting too.
 145 .RE
 146 .PP
 147 \fBReturns:\fP
 148 .RS 4
 149 the current reference count, can't safely be used except for debug printing.
 150 .RE
 151 .PP
 152