|
1 '\" te |
|
2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved. |
|
3 .TH gss_oid_to_str 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions" |
|
4 .SH NAME |
|
5 gss_oid_to_str \- convert an OID to a string |
|
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 \fB\fR\fBgss_oid_to_str\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBconst gss_OID\fR \fIoid\fR, |
|
13 \fBgss_buffer_t\fR\fIoid_str\fR); |
|
14 .fi |
|
15 |
|
16 .SH PARAMETERS |
|
17 .sp |
|
18 .ne 2 |
|
19 .mk |
|
20 .na |
|
21 \fB\fIminor_status\fR\fR |
|
22 .ad |
|
23 .RS 16n |
|
24 .rt |
|
25 Status code returned by underlying mechanism. |
|
26 .RE |
|
27 |
|
28 .sp |
|
29 .ne 2 |
|
30 .mk |
|
31 .na |
|
32 \fB\fIoid\fR\fR |
|
33 .ad |
|
34 .RS 16n |
|
35 .rt |
|
36 \fBGSS-API\fR \fBOID\fR structure to convert. |
|
37 .RE |
|
38 |
|
39 .sp |
|
40 .ne 2 |
|
41 .mk |
|
42 .na |
|
43 \fB\fIoid_str\fR\fR |
|
44 .ad |
|
45 .RS 16n |
|
46 .rt |
|
47 String to receive converted \fBOID\fR. |
|
48 .RE |
|
49 |
|
50 .SH DESCRIPTION |
|
51 .sp |
|
52 .LP |
|
53 The \fBgss_oid_to_str()\fR function converts a \fBGSS-API\fR \fBOID\fR structure to a string. You can use the function to convert the name of a mechanism from an \fBOID\fR to a simple string. This function is a convenience function, as is its complementary function, \fBgss_str_to_oid\fR(3GSS). |
|
54 .sp |
|
55 .LP |
|
56 If an \fBOID\fR must be created, use \fBgss_create_empty_oid_set\fR(3GSS) and \fBgss_add_oid_set_member\fR(3GSS) to create it. \fBOID\fRs created in this way must be released with \fBgss_release_oid_set\fR(3GSS). However, it is strongly suggested that applications use the default \fBGSS-API\fR mechanism instead of creating an \fBOID\fR for a specific mechanism. |
|
57 .SH ERRORS |
|
58 .sp |
|
59 .LP |
|
60 The \fBgss_oid_to_str()\fR function returns one of the following status codes: |
|
61 .sp |
|
62 .ne 2 |
|
63 .mk |
|
64 .na |
|
65 \fB\fBGSS_S_CALL_INACCESSIBLE_READ\fR\fR |
|
66 .ad |
|
67 .sp .6 |
|
68 .RS 4n |
|
69 A required input parameter could not be read. |
|
70 .RE |
|
71 |
|
72 .sp |
|
73 .ne 2 |
|
74 .mk |
|
75 .na |
|
76 \fB\fBGSS_S_CALL_INACCESSIBLE_WRITE\fR\fR |
|
77 .ad |
|
78 .sp .6 |
|
79 .RS 4n |
|
80 A required output parameter could not be written. |
|
81 .RE |
|
82 |
|
83 .sp |
|
84 .ne 2 |
|
85 .mk |
|
86 .na |
|
87 \fB\fBGSS_S_COMPLETE\fR\fR |
|
88 .ad |
|
89 .sp .6 |
|
90 .RS 4n |
|
91 Successful completion. |
|
92 .RE |
|
93 |
|
94 .sp |
|
95 .ne 2 |
|
96 .mk |
|
97 .na |
|
98 \fB\fBGSS_S_FAILURE\fR\fR |
|
99 .ad |
|
100 .sp .6 |
|
101 .RS 4n |
|
102 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. |
|
103 .RE |
|
104 |
|
105 .SH ATTRIBUTES |
|
106 .sp |
|
107 .LP |
|
108 See \fBattributes\fR(5) for descriptions of the following attributes: |
|
109 .sp |
|
110 |
|
111 .sp |
|
112 .TS |
|
113 tab() box; |
|
114 cw(2.75i) |cw(2.75i) |
|
115 lw(2.75i) |lw(2.75i) |
|
116 . |
|
117 ATTRIBUTE TYPEATTRIBUTE VALUE |
|
118 _ |
|
119 MT-LevelSafe |
|
120 .TE |
|
121 |
|
122 .SH SEE ALSO |
|
123 .sp |
|
124 .LP |
|
125 \fBgss_add_oid_set_member\fR(3GSS), \fBgss_create_empty_oid_set\fR(3GSS), \fBgss_release_oid_set\fR(3GSS), \fBgss_str_to_oid\fR(3GSS), \fBattributes\fR(5) |
|
126 .sp |
|
127 .LP |
|
128 |
|
129 .SH WARNINGS |
|
130 .sp |
|
131 .LP |
|
132 This function is included for compatibility only with programs using earlier versions of the \fBGSS-API\fR and should not be used for new programs. Other implementations of the \fBGSS-API\fR might not support this function, so portable programs should not rely on it. Sun might not continue to support this function. |