1.\" Copyright (c) 1999 Kungliga Tekniska H�gskolan
| 1.\" Copyright (c) 1999 Kungliga Tekniska H�gskolan
|
2.\" $Id: krb5_create_checksum.3,v 1.4 2002/08/28 15:30:49 joda Exp $
| 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_create_checksum.3,v 1.6 2003/04/16 13:58:14 lha Exp $
33.\"
|
3.Dd April 7, 1999
4.Dt NAME 3
5.Os HEIMDAL
6.Sh NAME
7.Nm krb5_checksum_is_collision_proof ,
8.Nm krb5_checksum_is_keyed ,
9.Nm krb5_checksumsize ,
10.Nm krb5_create_checksum ,
11.Nm krb5_verify_checksum
12.Nd creates and verifies checksums
13.Sh LIBRARY
14Kerberos 5 Library (libkrb5, -lkrb5)
15.Sh SYNOPSIS
| 34.Dd April 7, 1999
35.Dt NAME 3
36.Os HEIMDAL
37.Sh NAME
38.Nm krb5_checksum_is_collision_proof ,
39.Nm krb5_checksum_is_keyed ,
40.Nm krb5_checksumsize ,
41.Nm krb5_create_checksum ,
42.Nm krb5_verify_checksum
43.Nd creates and verifies checksums
44.Sh LIBRARY
45Kerberos 5 Library (libkrb5, -lkrb5)
46.Sh SYNOPSIS
|
16.Fd #include <krb5.h>
| 47.In krb5.h
|
17.Ft krb5_error_code
18.Fn krb5_create_checksum "krb5_context context" "krb5_crypto crypto" "unsigned usage_or_type" "void *data" "size_t len" "Checksum *result"
19.Ft krb5_error_code
20.Fn krb5_verify_checksum "krb5_context context" "krb5_crypto crypto" "krb5_key_usage usage" "void *data" "size_t len" "Checksum *cksum"
21.Ft krb5_boolean
22.Fn krb5_checksum_is_collision_proof "krb5_context context" "krb5_cksumtype type"
23.Ft krb5_boolean
24.Fn krb5_checksum_is_keyed "krb5_context context" "krb5_cksumtype type"
25.Sh DESCRIPTION
26These functions are used to create and verify checksums.
27.Fn krb5_create_checksum
28creates a checksum of the specified data, and puts it in
29.Fa result .
30If
31.Fa crypto
32is
33.Dv NULL ,
34.Fa usage_or_type
35specifies the checksum type to use; it must not be keyed. Otherwise
36.Fa crypto
37is an encryption context created by
38.Fn krb5_crypto_init ,
39and
40.Fa usage_or_type
41specifies a key-usage.
42.Pp
43.Fn krb5_verify_checksum
44verifies the
45.Fa checksum ,
46against the provided data.
47.Pp
48.Fn krb5_checksum_is_collision_proof
49returns true is the specified checksum is collision proof (that it's
50very unlikely that two strings has the same hash value, and that it's
51hard to find two strings that has the same hash). Examples of
52collision proof checksums are MD5, and SHA1, while CRC32 is not.
53.Pp
54.Fn krb5_checksum_is_keyed
55returns true if the specified checksum type is keyed (that the hash
56value is a function of both the data, and a separate key). Examples of
57keyed hash algorithms are HMAC-SHA1-DES3, and RSA-MD5-DES. The
58.Dq plain
59hash functions MD5, and SHA1 are not keyed.
60.\" .Sh EXAMPLE
61.\" .Sh BUGS
62.Sh SEE ALSO
63.Xr krb5_crypto_init 3 ,
64.Xr krb5_encrypt 3
| 48.Ft krb5_error_code
49.Fn krb5_create_checksum "krb5_context context" "krb5_crypto crypto" "unsigned usage_or_type" "void *data" "size_t len" "Checksum *result"
50.Ft krb5_error_code
51.Fn krb5_verify_checksum "krb5_context context" "krb5_crypto crypto" "krb5_key_usage usage" "void *data" "size_t len" "Checksum *cksum"
52.Ft krb5_boolean
53.Fn krb5_checksum_is_collision_proof "krb5_context context" "krb5_cksumtype type"
54.Ft krb5_boolean
55.Fn krb5_checksum_is_keyed "krb5_context context" "krb5_cksumtype type"
56.Sh DESCRIPTION
57These functions are used to create and verify checksums.
58.Fn krb5_create_checksum
59creates a checksum of the specified data, and puts it in
60.Fa result .
61If
62.Fa crypto
63is
64.Dv NULL ,
65.Fa usage_or_type
66specifies the checksum type to use; it must not be keyed. Otherwise
67.Fa crypto
68is an encryption context created by
69.Fn krb5_crypto_init ,
70and
71.Fa usage_or_type
72specifies a key-usage.
73.Pp
74.Fn krb5_verify_checksum
75verifies the
76.Fa checksum ,
77against the provided data.
78.Pp
79.Fn krb5_checksum_is_collision_proof
80returns true is the specified checksum is collision proof (that it's
81very unlikely that two strings has the same hash value, and that it's
82hard to find two strings that has the same hash). Examples of
83collision proof checksums are MD5, and SHA1, while CRC32 is not.
84.Pp
85.Fn krb5_checksum_is_keyed
86returns true if the specified checksum type is keyed (that the hash
87value is a function of both the data, and a separate key). Examples of
88keyed hash algorithms are HMAC-SHA1-DES3, and RSA-MD5-DES. The
89.Dq plain
90hash functions MD5, and SHA1 are not keyed.
91.\" .Sh EXAMPLE
92.\" .Sh BUGS
93.Sh SEE ALSO
94.Xr krb5_crypto_init 3 ,
95.Xr krb5_encrypt 3
|