lib/libgssapi/gss_inquire_cred_by_mech.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2005 Doug Rabson
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $FreeBSD$
  28 .\"
  29 .\" The following commands are required for all man pages.
  30 .Dd January 26, 2010
  31 .Dt GSS_INQUIRE_CRED_BY_MECH 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_inquire_cred_by_mech
  35 .Nd Obtain per-mechanism information about a credential
  36 .\" This next command is for sections 2 and 3 only.
  37 .\" .Sh LIBRARY
  38 .Sh SYNOPSIS
  39 .In "gssapi/gssapi.h"
  40 .Ft OM_uint32
  41 .Fo gss_inquire_cred_by_mech
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "const gss_cred_id_t cred_handle"
  44 .Fa "const gss_OID mech_type"
  45 .Fa "gss_name_t *name"
  46 .Fa "OM_uint32 *initiator_lifetime"
  47 .Fa "OM_uint32 *acceptor_lifetime"
  48 .Fa "gss_cred_usage_t *cred_usage"
  49 .Fc
  50 .Sh DESCRIPTION
  51 Obtains per-mechanism information about a credential.
  52 .Sh PARAMETERS
  53 .Bl -tag -width ".It initiator_lifetime"
  54 .It minor_status
  55 Mechanism specific status code.
  56 .It cred_handle
  57 A handle that refers to the target credential.
  58 Specify
  59 .Dv GSS_C_NO_CREDENTIAL
  60 to inquire about the default initiator principal.
  61 .It mech_type
  62 The mechanism for which information should be returned.
  63 .It name
  64 The name whose identity the credential asserts.
  65 Storage associated with this name must be freed by the application
  66 after use with a call to
  67 .Fn gss_release_name .
  68 Specify
  69 .Dv NULL
  70 if not required.
  71 .It initiator_lifetime
  72 The number of seconds for which the credential will remain capable of
  73 initiating security contexts under the specified mechanism.
  74 If the credential can no longer be used to initiate contexts,
  75 or if the credential usage for this mechanism is
  76 .Dv GSS_C_ACCEPT ,
  77 this parameter will be set to zero.
  78 If the implementation does not support expiration of initiator
  79 credentials,
  80 the value
  81 .Dv GSS_C_INDEFINITE
  82 will be returned.
  83 Specify
  84 .Dv NULL
  85 if not required.
  86 .It acceptor_lifetime
  87 The number of seconds for which the credential will remain capable of
  88 accepting security contexts under the specified mechanism.
  89 If the credential can no longer be used to accept contexts,
  90 or if the credential usage for this mechanism is
  91 .Dv GSS_C_INITIATE ,
  92 this parameter will be set to zero.
  93 If the implementation does not support expiration of acceptor
  94 credentials,
  95 the value
  96 .Dv GSS_C_INDEFINITE
  97 will be returned.
  98 Specify
  99 .Dv NULL
 100 if not required.
 101 .It cred_usage
 102 How the credential may be used with the specified mechanism.
 103 One of the following:
 104 .Bl -item -offset indent -compact
 105 .It
 106 .Dv GSS_C_INITIATE
 107 .It
 108 .Dv GSS_C_ACCEPT
 109 .It
 110 .Dv GSS_C_BOTH
 111 .El
 112 Specify
 113 .Dv NULL
 114 if not required.
 115 .El
 116 .Sh RETURN VALUES
 117 .Bl -tag -width ".It GSS_S_DEFECTIVE_CREDENTIAL"
 118 .It GSS_S_COMPLETE
 119 Successful completion
 120 .It GSS_S_NO_CRED
 121 The referenced credentials could not be accessed
 122 .It GSS_S_DEFECTIVE_CREDENTIAL
 123 The referenced credentials were invalid
 124 .It GSS_S_CREDENTIALS_EXPIRED
 125 The referenced credentials have expired.
 126 If the lifetime parameter was not passed as
 127 .Dv NULL ,
 128 it will be set to 0.
 129 .El
 130 .Sh SEE ALSO
 131 .Xr gss_release_name 3
 132 .Sh STANDARDS
 133 .Bl -tag -width ".It RFC 2743"
 134 .It RFC 2743
 135 Generic Security Service Application Program Interface Version 2, Update 1
 136 .It RFC 2744
 137 Generic Security Service API Version 2 : C-bindings
 138 .El
 139 .Sh HISTORY
 140 The
 141 .Nm
 142 function first appeared in
 143 .Fx 7.0 .
 144 .Sh AUTHORS
 145 John Wray, Iris Associates
 146 .Sh COPYRIGHT
 147 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 148 .Pp
 149 This document and translations of it may be copied and furnished to
 150 others, and derivative works that comment on or otherwise explain it
 151 or assist in its implementation may be prepared, copied, published
 152 and distributed, in whole or in part, without restriction of any
 153 kind, provided that the above copyright notice and this paragraph are
 154 included on all such copies and derivative works.  However, this
 155 document itself may not be modified in any way, such as by removing
 156 the copyright notice or references to the Internet Society or other
 157 Internet organizations, except as needed for the purpose of
 158 developing Internet standards in which case the procedures for
 159 copyrights defined in the Internet Standards process must be
 160 followed, or as required to translate it into languages other than
 161 English.
 162 .Pp
 163 The limited permissions granted above are perpetual and will not be
 164 revoked by the Internet Society or its successors or assigns.
 165 .Pp
 166 This document and the information contained herein is provided on an
 167 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 168 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 169 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 170 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 171 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.