xref: /freebsd/lib/libgssapi/gss_context_time.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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_CONTEXT_TIME 3 PRM
30.Os
31.Sh NAME
32.Nm gss_context_time
33.Nd Determine for how long a context will remain valid
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_context_time
40.Fa "OM_uint32 *minor_status"
41.Fa "const gss_ctx_id_t context_handle"
42.Fa "OM_uint32 *time_rec"
43.Fc
44.Sh DESCRIPTION
45Determines the number of seconds for which the specified context will
46remain valid.
47.Sh PARAMETERS
48.Bl -tag -width ".It context_handle"
49.It minor_status
50Mechanism specific status code.
51.It context_handle
52Identifies the context to be interrogated.
53.It time_rec
54Number of seconds that the context will remain valid.
55If the context has already expired, zero will be returned.
56.El
57.Sh RETURN VALUES
58.Bl -tag -width ".It GSS_S_CONTEXT_EXPIRED"
59.It GSS_S_COMPLETE
60Successful completion
61.It GSS_S_CONTEXT_EXPIRED
62The context has already expired
63.It GSS_S_NO_CONTEXT
64The context_handle parameter did not identify a valid context
65.El
66.Sh STANDARDS
67.Bl -tag -width ".It RFC 2743"
68.It RFC 2743
69Generic Security Service Application Program Interface Version 2, Update 1
70.It RFC 2744
71Generic Security Service API Version 2 : C-bindings
72.El
73.Sh HISTORY
74The
75.Nm
76function first appeared in
77.Fx 7.0 .
78.Sh AUTHORS
79John Wray, Iris Associates
80.Sh COPYRIGHT
81Copyright (C) The Internet Society (2000).  All Rights Reserved.
82.Pp
83This document and translations of it may be copied and furnished to
84others, and derivative works that comment on or otherwise explain it
85or assist in its implementation may be prepared, copied, published
86and distributed, in whole or in part, without restriction of any
87kind, provided that the above copyright notice and this paragraph are
88included on all such copies and derivative works.  However, this
89document itself may not be modified in any way, such as by removing
90the copyright notice or references to the Internet Society or other
91Internet organizations, except as needed for the purpose of
92developing Internet standards in which case the procedures for
93copyrights defined in the Internet Standards process must be
94followed, or as required to translate it into languages other than
95English.
96.Pp
97The limited permissions granted above are perpetual and will not be
98revoked by the Internet Society or its successors or assigns.
99.Pp
100This document and the information contained herein is provided on an
101"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
102TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
103BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
104HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
105MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
106