crypto/heimdal/doc/doxyout/krb5/man/man3/krb5_auth.3

   1 .TH "Heimdal Kerberos 5 authentication functions" 3 "11 Jan 2012" "Version 1.5.2" "HeimdalKerberos5library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Heimdal Kerberos 5 authentication functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_rd_req_in_ctx_alloc\fP (krb5_context context, krb5_rd_req_in_ctx *ctx)"
  11 .br
  12 .ti -1c
  13 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_rd_req_in_set_keytab\fP (krb5_context context, krb5_rd_req_in_ctx in, krb5_keytab keytab)"
  14 .br
  15 .ti -1c
  16 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_rd_req_in_set_pac_check\fP (krb5_context context, krb5_rd_req_in_ctx in, krb5_boolean flag)"
  17 .br
  18 .ti -1c
  19 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_rd_req_out_get_server\fP (krb5_context context, krb5_rd_req_out_ctx out, krb5_principal *principal)"
  20 .br
  21 .ti -1c
  22 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_rd_req_out_ctx_free\fP (krb5_context context, krb5_rd_req_out_ctx ctx)"
  23 .br
  24 .ti -1c
  25 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_rd_req_ctx\fP (krb5_context context, krb5_auth_context *auth_context, const krb5_data *inbuf, krb5_const_principal server, krb5_rd_req_in_ctx inctx, krb5_rd_req_out_ctx *outctx)"
  26 .br
  27 .in -1c
  28 .SH "Detailed Description"
  29 .PP
  30
  31 .SH "Function Documentation"
  32 .PP
  33 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_ctx (krb5_context context, krb5_auth_context * auth_context, const krb5_data * inbuf, krb5_const_principal server, krb5_rd_req_in_ctx inctx, krb5_rd_req_out_ctx * outctx)"
  34 .PP
  35 The core server function that verify application authentication requests from clients.
  36 .PP
  37 \fBParameters:\fP
  38 .RS 4
  39 \fIcontext\fP Keberos 5 context.
  40 .br
  41 \fIauth_context\fP the authentication context, can be NULL, then default values for the authentication context will used.
  42 .br
  43 \fIinbuf\fP the (AP-REQ) authentication buffer
  44 .br
  45 \fIserver\fP the server with authenticate as, if NULL the function will try to find any available credential in the keytab that will verify the reply. The function will prefer the server the server client specified in the AP-REQ, but if there is no mach, it will try all keytab entries for a match. This have serious performance issues for larger keytabs.
  46 .br
  47 \fIinctx\fP control the behavior of the function, if NULL, the default behavior is used.
  48 .br
  49 \fIoutctx\fP the return outctx, free with \fBkrb5_rd_req_out_ctx_free()\fP.
  50 .RE
  51 .PP
  52 \fBReturns:\fP
  53 .RS 4
  54 Kerberos 5 error code, see krb5_get_error_message().
  55 .RE
  56 .PP
  57
  58 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_in_ctx_alloc (krb5_context context, krb5_rd_req_in_ctx * ctx)"
  59 .PP
  60 Allocate a krb5_rd_req_in_ctx as an input parameter to \fBkrb5_rd_req_ctx()\fP. The caller should free the context with krb5_rd_req_in_ctx_free() when done with the context.
  61 .PP
  62 \fBParameters:\fP
  63 .RS 4
  64 \fIcontext\fP Keberos 5 context.
  65 .br
  66 \fIctx\fP in ctx to \fBkrb5_rd_req_ctx()\fP.
  67 .RE
  68 .PP
  69 \fBReturns:\fP
  70 .RS 4
  71 Kerberos 5 error code, see krb5_get_error_message().
  72 .RE
  73 .PP
  74
  75 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_in_set_keytab (krb5_context context, krb5_rd_req_in_ctx in, krb5_keytab keytab)"
  76 .PP
  77 Set the keytab that \fBkrb5_rd_req_ctx()\fP will use.
  78 .PP
  79 \fBParameters:\fP
  80 .RS 4
  81 \fIcontext\fP Keberos 5 context.
  82 .br
  83 \fIin\fP in ctx to \fBkrb5_rd_req_ctx()\fP.
  84 .br
  85 \fIkeytab\fP keytab that \fBkrb5_rd_req_ctx()\fP will use, only copy the pointer, so the caller must free they keytab after krb5_rd_req_in_ctx_free() is called.
  86 .RE
  87 .PP
  88 \fBReturns:\fP
  89 .RS 4
  90 Kerberos 5 error code, see krb5_get_error_message().
  91 .RE
  92 .PP
  93
  94 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_in_set_pac_check (krb5_context context, krb5_rd_req_in_ctx in, krb5_boolean flag)"
  95 .PP
  96 Set if krb5_rq_red() is going to check the Windows PAC or not
  97 .PP
  98 \fBParameters:\fP
  99 .RS 4
 100 \fIcontext\fP Keberos 5 context.
 101 .br
 102 \fIin\fP krb5_rd_req_in_ctx to check the option on.
 103 .br
 104 \fIflag\fP flag to select if to check the pac (TRUE) or not (FALSE).
 105 .RE
 106 .PP
 107 \fBReturns:\fP
 108 .RS 4
 109 Kerberos 5 error code, see krb5_get_error_message().
 110 .RE
 111 .PP
 112
 113 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_rd_req_out_ctx_free (krb5_context context, krb5_rd_req_out_ctx ctx)"
 114 .PP
 115 Free the krb5_rd_req_out_ctx.
 116 .PP
 117 \fBParameters:\fP
 118 .RS 4
 119 \fIcontext\fP Keberos 5 context.
 120 .br
 121 \fIctx\fP krb5_rd_req_out_ctx context to free.
 122 .RE
 123 .PP
 124
 125 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_out_get_server (krb5_context context, krb5_rd_req_out_ctx out, krb5_principal * principal)"
 126 .PP
 127 Get the principal that was used in the request from the client. Might not match whats in the ticket if \fBkrb5_rd_req_ctx()\fP searched in the keytab for a matching key.
 128 .PP
 129 \fBParameters:\fP
 130 .RS 4
 131 \fIcontext\fP a Kerberos 5 context.
 132 .br
 133 \fIout\fP a krb5_rd_req_out_ctx from \fBkrb5_rd_req_ctx()\fP.
 134 .br
 135 \fIprincipal\fP return principal, free with \fBkrb5_free_principal()\fP.
 136 .RE
 137 .PP
 138