1.\" $NetBSD: krb5_digest.3,v 1.1.1.2 2011/04/14 14:09:23 elric Exp $ 2.\" 3.\" Copyright (c) 2006 - 2007 Kungliga Tekniska Högskolan 4.\" (Royal Institute of Technology, Stockholm, Sweden). 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" 3. Neither the name of the Institute nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" Id 35.\" 36.Dd February 18, 2007 37.Dt KRB5_DIGEST 3 38.Os 39.Sh NAME 40.Nm krb5_digest , 41.Nm krb5_digest_alloc , 42.Nm krb5_digest_free , 43.Nm krb5_digest_set_server_cb , 44.Nm krb5_digest_set_type , 45.Nm krb5_digest_set_hostname , 46.Nm krb5_digest_get_server_nonce , 47.Nm krb5_digest_set_server_nonce , 48.Nm krb5_digest_get_opaque , 49.Nm krb5_digest_set_opaque , 50.Nm krb5_digest_get_identifier , 51.Nm krb5_digest_set_identifier , 52.Nm krb5_digest_init_request , 53.Nm krb5_digest_set_client_nonce , 54.Nm krb5_digest_set_digest , 55.Nm krb5_digest_set_username , 56.Nm krb5_digest_set_authid , 57.Nm krb5_digest_set_authentication_user , 58.Nm krb5_digest_set_realm , 59.Nm krb5_digest_set_method , 60.Nm krb5_digest_set_uri , 61.Nm krb5_digest_set_nonceCount , 62.Nm krb5_digest_set_qop , 63.Nm krb5_digest_request , 64.Nm krb5_digest_get_responseData , 65.Nm krb5_digest_get_rsp , 66.Nm krb5_digest_get_tickets , 67.Nm krb5_digest_get_client_binding , 68.Nm krb5_digest_get_a1_hash 69.Nd remote digest (HTTP-DIGEST, SASL, CHAP) suppport 70.Sh LIBRARY 71Kerberos 5 Library (libkrb5, -lkrb5) 72.Sh SYNOPSIS 73.In krb5/krb5.h 74.Pp 75.Li "typedef struct krb5_digest *krb5_digest;" 76.Pp 77.Ft krb5_error_code 78.Fo krb5_digest_alloc 79.Fa "krb5_context context" 80.Fa "krb5_digest *digest" 81.Fc 82.Ft void 83.Fo krb5_digest_free 84.Fa "krb5_digest digest" 85.Fc 86.Ft krb5_error_code 87.Fo krb5_digest_set_type 88.Fa "krb5_context context" 89.Fa "krb5_digest digest" 90.Fa "const char *type" 91.Fc 92.Ft krb5_error_code 93.Fo krb5_digest_set_server_cb 94.Fa "krb5_context context" 95.Fa "krb5_digest digest" 96.Fa "const char *type" 97.Fa "const char *binding" 98.Fc 99.Ft krb5_error_code 100.Fo krb5_digest_set_hostname 101.Fa "krb5_context context" 102.Fa "krb5_digest digest" 103.Fa "const char *hostname" 104.Fc 105.Ft "const char *" 106.Fo krb5_digest_get_server_nonce 107.Fa "krb5_context context" 108.Fa "krb5_digest digest" 109.Fc 110.Ft krb5_error_code 111.Fo krb5_digest_set_server_nonce 112.Fa "krb5_context context" 113.Fa "krb5_digest digest" 114.Fa "const char *nonce" 115.Fc 116.Ft "const char *" 117.Fo krb5_digest_get_opaque 118.Fa "krb5_context context" 119.Fa "krb5_digest digest" 120.Fc 121.Ft krb5_error_code 122.Fo krb5_digest_set_opaque 123.Fa "krb5_context context" 124.Fa "krb5_digest digest" 125.Fa "const char *opaque" 126.Fc 127.Ft "const char *" 128.Fo krb5_digest_get_identifier 129.Fa "krb5_context context" 130.Fa "krb5_digest digest" 131.Fc 132.Ft krb5_error_code 133.Fo krb5_digest_set_identifier 134.Fa "krb5_context context" 135.Fa "krb5_digest digest" 136.Fa "const char *id" 137.Fc 138.Ft krb5_error_code 139.Fo krb5_digest_init_request 140.Fa "krb5_context context" 141.Fa "krb5_digest digest" 142.Fa "krb5_realm realm" 143.Fa "krb5_ccache ccache" 144.Fc 145.Ft krb5_error_code 146.Fo krb5_digest_set_client_nonce 147.Fa "krb5_context context" 148.Fa "krb5_digest digest" 149.Fa "const char *nonce" 150.Fc 151.Ft krb5_error_code 152.Fo krb5_digest_set_digest 153.Fa "krb5_context context" 154.Fa "krb5_digest digest" 155.Fa "const char *dgst" 156.Fc 157.Ft krb5_error_code 158.Fo krb5_digest_set_username 159.Fa "krb5_context context" 160.Fa "krb5_digest digest" 161.Fa "const char *username" 162.Fc 163.Ft krb5_error_code 164.Fo krb5_digest_set_authid 165.Fa "krb5_context context" 166.Fa "krb5_digest digest" 167.Fa "const char *authid" 168.Fc 169.Ft krb5_error_code 170.Fo krb5_digest_set_authentication_user 171.Fa "krb5_context context" 172.Fa "krb5_digest digest" 173.Fa "krb5_principal authentication_user" 174.Fc 175.Ft krb5_error_code 176.Fo krb5_digest_set_realm 177.Fa "krb5_context context" 178.Fa "krb5_digest digest" 179.Fa "const char *realm" 180.Fc 181.Ft krb5_error_code 182.Fo krb5_digest_set_method 183.Fa "krb5_context context" 184.Fa "krb5_digest digest" 185.Fa "const char *method" 186.Fc 187.Ft krb5_error_code 188.Fo krb5_digest_set_uri 189.Fa "krb5_context context" 190.Fa "krb5_digest digest" 191.Fa "const char *uri" 192.Fc 193.Ft krb5_error_code 194.Fo krb5_digest_set_nonceCount 195.Fa "krb5_context context" 196.Fa "krb5_digest digest" 197.Fa "const char *nonce_count" 198.Fc 199.Ft krb5_error_code 200.Fo krb5_digest_set_qop 201.Fa "krb5_context context" 202.Fa "krb5_digest digest" 203.Fa "const char *qop" 204.Fc 205.Ft krb5_error_code 206.Fo krb5_digest_request 207.Fa "krb5_context context" 208.Fa "krb5_digest digest" 209.Fa "krb5_realm realm" 210.Fa "krb5_ccache ccache" 211.Fc 212.Ft "const char *" 213.Fo krb5_digest_get_responseData 214.Fa "krb5_context context" 215.Fa "krb5_digest digest" 216.Fc 217.Ft "const char *" 218.Fo krb5_digest_get_rsp 219.Fa "krb5_context context" 220.Fa "krb5_digest digest" 221.Fc 222.Ft krb5_error_code 223.Fo krb5_digest_get_tickets 224.Fa "krb5_context context" 225.Fa "krb5_digest digest" 226.Fa "Ticket **tickets" 227.Fc 228.Ft krb5_error_code 229.Fo krb5_digest_get_client_binding 230.Fa "krb5_context context" 231.Fa "krb5_digest digest" 232.Fa "char **type" 233.Fa "char **binding" 234.Fc 235.Ft krb5_error_code 236.Fo krb5_digest_get_a1_hash 237.Fa "krb5_context context" 238.Fa "krb5_digest digest" 239.Fa "krb5_data *data" 240.Fc 241.Sh DESCRIPTION 242The 243.Fn krb5_digest_alloc 244function allocatates the 245.Fa digest 246structure. The structure should be freed with 247.Fn krb5_digest_free 248when it is no longer being used. 249.Pp 250.Fn krb5_digest_alloc 251returns 0 to indicate success. 252Otherwise an kerberos code is returned and the pointer that 253.Fa digest 254points to is set to 255.Dv NULL . 256.Pp 257.Fn krb5_digest_free 258free the structure 259.Fa digest . 260.Sh SEE ALSO 261.Xr krb5 3 , 262.Xr kerberos 8 263