share/man/man3gss/gss_indicate_mechs.3gss

   1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GSS_INDICATE_MECHS 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_indicate_mechs \- determine available security mechanisms
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_indicate_mechs\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBgss_OID_set  *\fR\fImech_set\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgss_indicate_mechs()\fR function enables an application to determine
  23 available underlying security mechanisms.
  24 .SH PARAMETERS
  25 .sp
  26 .LP
  27 The parameter descriptions for \fBgss_indicate_mechs()\fR follow:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIminor_status\fR\fR
  32 .ad
  33 .RS 16n
  34 A mechanism-specific status code.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fImech_set\fR\fR
  41 .ad
  42 .RS 16n
  43 Set of supported mechanisms. The returned \fBgss_OID_set\fR value will be a
  44 dynamically-allocated \fBOID\fR set that should be released by the caller after
  45 use with a call to \fBgss_release_oid_set\fR(3GSS).
  46 .RE
  47
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 The \fBgss_indicate_mechs()\fR function may return the following status codes:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBGSS_S_COMPLETE\fR\fR
  56 .ad
  57 .RS 18n
  58 Successful completion.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBGSS_S_FAILURE\fR\fR
  65 .ad
  66 .RS 18n
  67 The underlying mechanism detected an error for which no specific \fBGSS\fR
  68 status code is defined.  The mechanism-specific status code reported by means
  69 of the \fIminor_status\fR parameter details the error condition.
  70 .RE
  71
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5)  for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 MT-Level        Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5)
  92 .sp
  93 .LP
  94 \fISolaris Security for Developers Guide\fR