third_party/heimdal/lib/krb5/krb5_mk_safe.3

   1 .\" Copyright (c) 2003 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$
  33 .\"
  34 .Dd May  1, 2006
  35 .Dt KRB5_MK_SAFE 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_mk_safe ,
  39 .Nm krb5_mk_priv
  40 .Nd generates integrity protected and/or encrypted messages
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5.h
  45 .Pp
  46 .Ft krb5_error_code
  47 .Fn krb5_mk_priv "krb5_context context" "krb5_auth_context auth_context" "const krb5_data *userdata" "krb5_data *outbuf" "krb5_replay_data *outdata"
  48 .Ft krb5_error_code
  49 .Fn krb5_mk_safe "krb5_context context" "krb5_auth_context auth_context" "const krb5_data *userdata" "krb5_data *outbuf" "krb5_replay_data *outdata"
  50 .Sh DESCRIPTION
  51 .Fn krb5_mk_safe
  52 and
  53 .Fn krb5_mk_priv
  54 formats
  55 .Li KRB-SAFE
  56 (integrity protected)
  57 and
  58 .Li KRB-PRIV
  59 (also encrypted)
  60 messages into
  61 .Fa outbuf .
  62 The actual message data is taken from
  63 .Fa userdata .
  64 If the
  65 .Dv KRB5_AUTH_CONTEXT_DO_SEQUENCE
  66 or
  67 .Dv KRB5_AUTH_CONTEXT_DO_TIME
  68 flags are set in the
  69 .Fa auth_context ,
  70 sequence numbers and time stamps are generated.
  71 If the
  72 .Dv KRB5_AUTH_CONTEXT_RET_SEQUENCE
  73 or
  74 .Dv KRB5_AUTH_CONTEXT_RET_TIME
  75 flags are set
  76 they are also returned in the
  77 .Fa outdata
  78 parameter.
  79 .Sh SEE ALSO
  80 .Xr krb5_auth_con_init 3 ,
  81 .Xr krb5_rd_priv 3 ,
  82 .Xr krb5_rd_safe 3