crypto/external/bsd/netpgp/dist/src/librsa/libnetpgprsa.3

   1 .\" $NetBSD: libnetpgprsa.3,v 1.5 2014/03/18 18:20:35 riastradh Exp $
   2 .\"
   3 .\" Copyright (c) 2012 Alistair Crooks <agc@NetBSD.org>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .Dd April 13, 2012
  27 .Dt LIBNETPGPRSA 3
  28 .Os
  29 .Sh NAME
  30 .Nm libnetpgprsa
  31 .Nd BIGNUM library of multi-precision integers
  32 .Sh LIBRARY
  33 .Lb libnetpgprsa
  34 .Sh SYNOPSIS
  35 .In netpgp/rsa.h
  36 .Ft RSA *
  37 .Fo RSA_new
  38 .Fa "void"
  39 .Fc
  40 .Ft int
  41 .Fo RSA_size
  42 .Fa "const RSA *rsa"
  43 .Fc
  44 .Ft void
  45 .Fo RSA_free
  46 .Fa "RSA *rsa"
  47 .Fc
  48 .Ft int
  49 .Fo RSA_check_key
  50 .Fa "RSA *rsa"
  51 .Fc
  52 .Ft RSA *
  53 .Fo RSA_generate_key
  54 .Fa "int num" "unsigned long e" "void (*callback)(int, int, void *)" "void *callbackarg"
  55 .Fc
  56 .Ft int
  57 .Fo RSA_public_encrypt
  58 .Fa "int siglen" "const uint8_t *signature" "uint8_t *to" "RSA *rsa" "int padding"
  59 .Fc
  60 .Ft int
  61 .Fo RSA_private_encrypt
  62 .Fa "int siglen" "const uint8_t *signature" "uint8_t *to" "RSA *rsa" "int padding"
  63 .Fc
  64 .Ft int
  65 .Fo RSA_private_decrypt
  66 .Fa "int siglen" "const uint8_t *signature" "uint8_t *to" "RSA *rsa" "int padding"
  67 .Fc
  68 .Pp
  69 .Ft DSA *
  70 .Fo DSA_new
  71 .Fa "void"
  72 .Fc
  73 .Ft int
  74 .Fo DSA_size
  75 .Fa "const DSA *dsa"
  76 .Fc
  77 .Ft void
  78 .Fo DSA_free
  79 .Fa "DSA *dsa"
  80 .Fc
  81 .Ft DSA_SIG *
  82 .Fo DSA_SIG_new
  83 .Fa "void"
  84 .Fc
  85 .Ft void
  86 .Fo DSA_SIG_free
  87 .Fa "DSA_SIG *sig"
  88 .Fc
  89 .Ft int
  90 .Fo DSA_do_verify
  91 .Fa "const unsigned char *digest" "int digestlen" "DSA_SIG *sig" "DSA *dsa"
  92 .Fc
  93 .Ft int
  94 .Fo DSA_do_sign
  95 .Fa "const unsigned char *digest" "int digestlen" "DSA *dsa"
  96 .Fc
  97 .Sh DESCRIPTION
  98 .Nm
  99 is a small library which provides RSA signing,
 100 encryption and decryption, and DSA signing.
 101 RSA and DSA verification are provided by the
 102 .Xr libnetpgpverify 3
 103 library.
 104 .Sh SEE ALSO
 105 .Xr libnetpgpbn 3 ,
 106 .Xr libnetpgpverify 3
 107 .Sh HISTORY
 108 The
 109 .Nm
 110 library first appeared in
 111 .Nx 7.0 .
 112 .Sh AUTHORS
 113 .An Alistair Crooks Aq Mt agc@NetBSD.org