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