1gss_display_statuGse(n3eGrSiSc)Security Services API Library Fgusnsc_tdiiosnpslay_status(3GSS)
2
6 gss_display_status - convert a GSS-API status code to text
7
9 cc [ flag... ] file... -lgss [ library... ]
10 #include <gssapi/gssapi.h>
11 OM_uint32 gss_display_status(OM_uint32 *minor_status,
13 OM_uint32 status value,int status type,
14 const gss_OID mech_type, OM_uint32 *message_context,
15 gss_buffer_t status string);
16
19 The gss_display_status() function enables an application to obtain a
20 textual representation of a GSS-API status code for display to the user
21 or for logging purposes. Because some status values may indicate mul‐
22 tiple conditions, applications may need to call gss_display_status()
23 multiple times, with each call generating a single text string.
24 The message_context parameter is used by gss_acquire_cred() to store
27 state information on error messages that are extracted from a given
28 status_value. The message_context parameter must be initialized to 0 by
29 the application prior to the first call, and gss_display_status() will
30 return a non-zero value in this parameter if there are further messages
31 to extract.
32 The message_context parameter contains all state information required
35 by gss_display_status() to extract further messages from the sta‐
36 tus_value. If a non-zero value is returned in this parameter, the
37 application is not required to call gss_display_status() again unless
38 subsequent messages are desired.
39
41 The parameter descriptions for gss_display_status() follow:
42 minor_status Status code returned by the underlying mechanism.
44 status_value Status value to be converted.
47 status_type If the value is GSS_C_GSS_CODE, status_value is a
50 GSS-API status code. If the value is
51 GSS_C_MECH_CODE, then status_value is a mechanism
52 status code.
53 mech_type Underlying mechanism that is used to interpret a
56 minor status value. Supply GSS_C_NO_OID to obtain
57 the system default.
58 message_context Should be initialized to zero prior to the first
61 call. On return from gss_display_status(), a non-
62 zero status_value parameter indicates that addi‐
63 tional messages may be extracted from the status
64 code by means of subsequent calls to gss_dis‐
65 play_status(), passing the same status_value, sta‐
66 tus_type, mech_type, and message_contextparameters.
67 status_string Textual representation of the status_value. Storage
70 associated with this parameter must be freed by the
71 application after use with a call to
72 gss_release_buffer(3GSS).
73
76 The gss_display_status() function may return the following status
77 codes:
78 GSS_S_COMPLETE Successful completion.
80 GSS_S_BAD_MECH Indicates that translation in accordance with an
83 unsupported mechanism type was requested.
84 GSS_S_BAD_STATUS The status value was not recognized, or the status
87 type was neither GSS_C_GSS_CODE nor
88 GSS_C_MECH_CODE.
89 GSS_S_FAILURE The underlying mechanism detected an error for
92 which no specific GSS status code is defined. The
93 mechanism-specific status code reported by means of
94 the minor_status parameter details the error condi‐
95 tion.
96
99 See attributes(5) for descriptions of the following attributes:
100 ┌─────────────────────────────┬─────────────────────────────┐
105 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
106 ├─────────────────────────────┼─────────────────────────────┤
107 │Availability │SUNWgss (32-bit) │
108 ├─────────────────────────────┼─────────────────────────────┤
109 │ │SUNWgssx (64-bit) │
110 ├─────────────────────────────┼─────────────────────────────┤
111 │MT-Level │Safe │
112 └─────────────────────────────┴─────────────────────────────┘
113
115 gss_acquire_cred(3GSS), gss_release_buffer(3GSS), attributes(5)
116 Solaris Security for Developers Guide
119SunOS 5.11 14 Jan 2003 gss_display_status(3GSS)