crypto/heimdal-0.6.3/lib/krb5/krb5_crypto_init.3

   1 .\" Copyright (c) 1999 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Id: krb5_crypto_init.3,v 1.6 2003/04/16 13:58:15 lha Exp $
  33 .\"
  34 .Dd April  7, 1999
  35 .Dt NAME 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_crypto_init ,
  39 .Nm krb5_crypto_destroy
  40 .Nd initialize encryption context
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5.h
  45 .Ft krb5_error_code
  46 .Fn krb5_crypto_init "krb5_context context" "krb5_keyblock *key" "krb5_enctype enctype" "krb5_crypto *crypto"
  47 .Ft krb5_error_code
  48 .Fn krb5_crypto_destroy "krb5_context context" "krb5_crypto crypto"
  49 .Sh DESCRIPTION
  50 These functions are used to initialize an encryption context that can
  51 be used to encrypt or checksum data.
  52 .Pp
  53 The
  54 .Fn krb5_crypt_init
  55 initializes the encrytion context
  56 .Fa crypto .
  57 The
  58 .Fa key
  59 parameter is the key to use for encryption, and checksums. The
  60 encryption type to use is taken from the key, but can be overridden
  61 with the
  62 .Fa enctype parameter .
  63 .Pp
  64 .Fn krb5_crypto_destroy
  65 frees a previously allocated encrypion context.
  66 .\" .Sh EXAMPLE
  67 .\" .Sh BUGS
  68 .Sh SEE ALSO
  69 .Xr krb5_create_checksum 3 ,
  70 .Xr krb5_encrypt 3