xref: /freebsd/lib/libgssapi/gss_test_oid_set_member.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.\" The following commands are required for all man pages.
28.Dd January 26, 2010
29.Dt GSS_TEST_OID_SET_MEMBER 3 PRM
30.Os
31.Sh NAME
32.Nm gss_test_oid_set_member
33.Nd Determines whether an object identifier is a member of a set
34.\" This next command is for sections 2 and 3 only.
35.\" .Sh LIBRARY
36.Sh SYNOPSIS
37.In "gssapi/gssapi.h"
38.Ft OM_uint32
39.Fo gss_test_oid_set_member
40.Fa "OM_uint32 *minor_status"
41.Fa "const gss_OID member"
42.Fa "const gss_OID_set set"
43.Fa "int *present"
44.Fc
45.Sh DESCRIPTION
46Interrogate an Object Identifier set to determine whether a specified
47Object Identifier is a member.
48This routine is intended to be used with OID sets returned by
49.Fn gss_indicate_mechs ,
50.Fn gss_acquire_cred ,
51and
52.Fn gss_inquire_cred ,
53but will also work with user-generated sets.
54.Sh PARAMETERS
55.Bl -tag -width ".It minor_status"
56.It minor_status
57Mechanism specific status code.
58.It member
59The object identifier whose presence is to be tested.
60.It set
61The Object Identifier set.
62.It present
63Non-zero if the specified OID is a member of the set, zero if not.
64.El
65.Sh RETURN VALUES
66.Bl -tag -width ".It GSS_S_COMPLETE"
67.It GSS_S_COMPLETE
68Successful completion
69.El
70.Sh SEE ALSO
71.Xr gss_acquire_cred 3 ,
72.Xr gss_indicate_mechs 3 ,
73.Xr gss_inquire_cred 3
74.Sh STANDARDS
75.Bl -tag -width ".It RFC 2743"
76.It RFC 2743
77Generic Security Service Application Program Interface Version 2, Update 1
78.It RFC 2744
79Generic Security Service API Version 2 : C-bindings
80.El
81.Sh HISTORY
82The
83.Nm
84function first appeared in
85.Fx 7.0 .
86.Sh AUTHORS
87John Wray, Iris Associates
88.Sh COPYRIGHT
89Copyright (C) The Internet Society (2000).  All Rights Reserved.
90.Pp
91This document and translations of it may be copied and furnished to
92others, and derivative works that comment on or otherwise explain it
93or assist in its implementation may be prepared, copied, published
94and distributed, in whole or in part, without restriction of any
95kind, provided that the above copyright notice and this paragraph are
96included on all such copies and derivative works.  However, this
97document itself may not be modified in any way, such as by removing
98the copyright notice or references to the Internet Society or other
99Internet organizations, except as needed for the purpose of
100developing Internet standards in which case the procedures for
101copyrights defined in the Internet Standards process must be
102followed, or as required to translate it into languages other than
103English.
104.Pp
105The limited permissions granted above are perpetual and will not be
106revoked by the Internet Society or its successors or assigns.
107.Pp
108This document and the information contained herein is provided on an
109"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
110TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
111BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
112HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
113MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
114