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