crypto/dist/heimdal/lib/krb5/krb5_digest.3

   1 .\" Copyright (c) 2006 - 2007 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_digest.3 20259 2007-02-17 23:49:54Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd February  18, 2007
  36 .Dt KRB5_DIGEST 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_digest ,
  40 .Nm krb5_digest_alloc ,
  41 .Nm krb5_digest_free ,
  42 .Nm krb5_digest_set_server_cb ,
  43 .Nm krb5_digest_set_type ,
  44 .Nm krb5_digest_set_hostname ,
  45 .Nm krb5_digest_get_server_nonce ,
  46 .Nm krb5_digest_set_server_nonce ,
  47 .Nm krb5_digest_get_opaque ,
  48 .Nm krb5_digest_set_opaque ,
  49 .Nm krb5_digest_get_identifier ,
  50 .Nm krb5_digest_set_identifier ,
  51 .Nm krb5_digest_init_request ,
  52 .Nm krb5_digest_set_client_nonce ,
  53 .Nm krb5_digest_set_digest ,
  54 .Nm krb5_digest_set_username ,
  55 .Nm krb5_digest_set_authid ,
  56 .Nm krb5_digest_set_authentication_user ,
  57 .Nm krb5_digest_set_realm ,
  58 .Nm krb5_digest_set_method ,
  59 .Nm krb5_digest_set_uri ,
  60 .Nm krb5_digest_set_nonceCount ,
  61 .Nm krb5_digest_set_qop ,
  62 .Nm krb5_digest_request ,
  63 .Nm krb5_digest_get_responseData ,
  64 .Nm krb5_digest_get_rsp ,
  65 .Nm krb5_digest_get_tickets ,
  66 .Nm krb5_digest_get_client_binding ,
  67 .Nm krb5_digest_get_a1_hash
  68 .Nd remote digest (HTTP-DIGEST, SASL, CHAP) suppport
  69 .Sh LIBRARY
  70 Kerberos 5 Library (libkrb5, -lkrb5)
  71 .Sh SYNOPSIS
  72 .In krb5/krb5.h
  73 .Pp
  74 .Li "typedef struct krb5_digest *krb5_digest;"
  75 .Pp
  76 .Ft krb5_error_code
  77 .Fo krb5_digest_alloc
  78 .Fa "krb5_context context"
  79 .Fa "krb5_digest *digest"
  80 .Fc
  81 .Ft void
  82 .Fo krb5_digest_free
  83 .Fa "krb5_digest digest"
  84 .Fc
  85 .Ft krb5_error_code
  86 .Fo krb5_digest_set_type
  87 .Fa "krb5_context context"
  88 .Fa "krb5_digest digest"
  89 .Fa "const char *type"
  90 .Fc
  91 .Ft krb5_error_code
  92 .Fo krb5_digest_set_server_cb
  93 .Fa "krb5_context context"
  94 .Fa "krb5_digest digest"
  95 .Fa "const char *type"
  96 .Fa "const char *binding"
  97 .Fc
  98 .Ft krb5_error_code
  99 .Fo krb5_digest_set_hostname
 100 .Fa "krb5_context context"
 101 .Fa "krb5_digest digest"
 102 .Fa "const char *hostname"
 103 .Fc
 104 .Ft "const char *"
 105 .Fo krb5_digest_get_server_nonce
 106 .Fa "krb5_context context"
 107 .Fa "krb5_digest digest"
 108 .Fc
 109 .Ft krb5_error_code
 110 .Fo krb5_digest_set_server_nonce
 111 .Fa "krb5_context context"
 112 .Fa "krb5_digest digest"
 113 .Fa "const char *nonce"
 114 .Fc
 115 .Ft "const char *"
 116 .Fo krb5_digest_get_opaque
 117 .Fa "krb5_context context"
 118 .Fa "krb5_digest digest"
 119 .Fc
 120 .Ft krb5_error_code
 121 .Fo krb5_digest_set_opaque
 122 .Fa "krb5_context context"
 123 .Fa "krb5_digest digest"
 124 .Fa "const char *opaque"
 125 .Fc
 126 .Ft "const char *"
 127 .Fo krb5_digest_get_identifier
 128 .Fa "krb5_context context"
 129 .Fa "krb5_digest digest"
 130 .Fc
 131 .Ft krb5_error_code
 132 .Fo krb5_digest_set_identifier
 133 .Fa "krb5_context context"
 134 .Fa "krb5_digest digest"
 135 .Fa "const char *id"
 136 .Fc
 137 .Ft krb5_error_code
 138 .Fo krb5_digest_init_request
 139 .Fa "krb5_context context"
 140 .Fa "krb5_digest digest"
 141 .Fa "krb5_realm realm"
 142 .Fa "krb5_ccache ccache"
 143 .Fc
 144 .Ft krb5_error_code
 145 .Fo krb5_digest_set_client_nonce
 146 .Fa "krb5_context context"
 147 .Fa "krb5_digest digest"
 148 .Fa "const char *nonce"
 149 .Fc
 150 .Ft krb5_error_code
 151 .Fo krb5_digest_set_digest
 152 .Fa "krb5_context context"
 153 .Fa "krb5_digest digest"
 154 .Fa "const char *dgst"
 155 .Fc
 156 .Ft krb5_error_code
 157 .Fo krb5_digest_set_username
 158 .Fa "krb5_context context"
 159 .Fa "krb5_digest digest"
 160 .Fa "const char *username"
 161 .Fc
 162 .Ft krb5_error_code
 163 .Fo krb5_digest_set_authid
 164 .Fa "krb5_context context"
 165 .Fa "krb5_digest digest"
 166 .Fa "const char *authid"
 167 .Fc
 168 .Ft krb5_error_code
 169 .Fo krb5_digest_set_authentication_user
 170 .Fa "krb5_context context"
 171 .Fa "krb5_digest digest"
 172 .Fa "krb5_principal authentication_user"
 173 .Fc
 174 .Ft krb5_error_code
 175 .Fo krb5_digest_set_realm
 176 .Fa "krb5_context context"
 177 .Fa "krb5_digest digest"
 178 .Fa "const char *realm"
 179 .Fc
 180 .Ft krb5_error_code
 181 .Fo krb5_digest_set_method
 182 .Fa "krb5_context context"
 183 .Fa "krb5_digest digest"
 184 .Fa "const char *method"
 185 .Fc
 186 .Ft krb5_error_code
 187 .Fo krb5_digest_set_uri
 188 .Fa "krb5_context context"
 189 .Fa "krb5_digest digest"
 190 .Fa "const char *uri"
 191 .Fc
 192 .Ft krb5_error_code
 193 .Fo krb5_digest_set_nonceCount
 194 .Fa "krb5_context context"
 195 .Fa "krb5_digest digest"
 196 .Fa "const char *nonce_count"
 197 .Fc
 198 .Ft krb5_error_code
 199 .Fo krb5_digest_set_qop
 200 .Fa "krb5_context context"
 201 .Fa "krb5_digest digest"
 202 .Fa "const char *qop"
 203 .Fc
 204 .Ft krb5_error_code
 205 .Fo krb5_digest_request
 206 .Fa "krb5_context context"
 207 .Fa "krb5_digest digest"
 208 .Fa "krb5_realm realm"
 209 .Fa "krb5_ccache ccache"
 210 .Fc
 211 .Ft "const char *"
 212 .Fo krb5_digest_get_responseData
 213 .Fa "krb5_context context"
 214 .Fa "krb5_digest digest"
 215 .Fc
 216 .Ft "const char *"
 217 .Fo krb5_digest_get_rsp
 218 .Fa "krb5_context context"
 219 .Fa "krb5_digest digest"
 220 .Fc
 221 .Ft krb5_error_code
 222 .Fo krb5_digest_get_tickets
 223 .Fa "krb5_context context"
 224 .Fa "krb5_digest digest"
 225 .Fa "Ticket **tickets"
 226 .Fc
 227 .Ft krb5_error_code
 228 .Fo krb5_digest_get_client_binding
 229 .Fa "krb5_context context"
 230 .Fa "krb5_digest digest"
 231 .Fa "char **type"
 232 .Fa "char **binding"
 233 .Fc
 234 .Ft krb5_error_code
 235 .Fo krb5_digest_get_a1_hash
 236 .Fa "krb5_context context"
 237 .Fa "krb5_digest digest"
 238 .Fa "krb5_data *data"
 239 .Fc
 240 .Sh DESCRIPTION
 241 The
 242 .Fn krb5_digest_alloc
 243 function allocatates the
 244 .Fa digest
 245 structure.  The structure should be freed with
 246 .Fn krb5_digest_free
 247 when it is no longer being used.
 248 .Pp
 249 .Fn krb5_digest_alloc
 250 returns 0 to indicate success.
 251 Otherwise an kerberos code is returned and the pointer that
 252 .Fa digest
 253 points to is set to
 254 .Dv NULL .
 255 .Pp
 256 .Fn krb5_digest_free
 257 free the structure
 258 .Fa digest .
 259 .Sh SEE ALSO
 260 .Xr krb5 3 ,
 261 .Xr kerberos 8