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