1 '\" te

     2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.

     3 .TH gss_indicate_mechs 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"

     4 .SH NAME

     5 gss_indicate_mechs \- determine available security mechanisms

     6 .SH SYNOPSIS

     7 .LP

     8 .nf

     9 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ] 

    10 #include <gssapi/gssapi.h>

    11 

    12 \fBOM_uint32\fR \fBgss_indicate_mechs\fR(\fBOM_uint32 *\fR\fIminor_status\fR,

    13      \fBgss_OID_set  *\fR\fImech_set\fR);

    14 .fi

    15 

    16 .SH DESCRIPTION

    17 .sp

    18 .LP

    19 The \fBgss_indicate_mechs()\fR function enables an application to determine available underlying security mechanisms.

    20 .SH PARAMETERS

    21 .sp

    22 .LP

    23 The parameter descriptions for \fBgss_indicate_mechs()\fR follow:

    24 .sp

    25 .ne 2

    26 .mk

    27 .na

    28 \fB\fIminor_status\fR\fR

    29 .ad

    30 .RS 16n

    31 .rt  

    32 A mechanism-specific status code.

    33 .RE

    34 

    35 .sp

    36 .ne 2

    37 .mk

    38 .na

    39 \fB\fImech_set\fR\fR

    40 .ad

    41 .RS 16n

    42 .rt  

    43 Set of supported mechanisms. The returned \fBgss_OID_set\fR value will be a dynamically-allocated \fBOID\fR set that should be released by the caller after use with a call to \fBgss_release_oid_set\fR(3GSS). 

    44 .RE

    45 

    46 .SH ERRORS

    47 .sp

    48 .LP

    49 The \fBgss_indicate_mechs()\fR function may return the following status codes:

    50 .sp

    51 .ne 2

    52 .mk

    53 .na

    54 \fB\fBGSS_S_COMPLETE\fR\fR

    55 .ad

    56 .RS 18n

    57 .rt  

    58 Successful completion.

    59 .RE

    60 

    61 .sp

    62 .ne 2

    63 .mk

    64 .na

    65 \fB\fBGSS_S_FAILURE\fR\fR

    66 .ad

    67 .RS 18n

    68 .rt  

    69 The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined.  The mechanism-specific status code reported by means 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 tab() box;

    81 cw(2.75i) |cw(2.75i) 

    82 lw(2.75i) |lw(2.75i) 

    83 .

    84 ATTRIBUTE TYPEATTRIBUTE VALUE

    85 _

    86 MT-LevelSafe

    87 .TE

    88 

    89 .SH SEE ALSO

    90 .sp

    91 .LP

    92 \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5)

    93 .sp

    94 .LP

    95