File: gss_encapsulate_token.3

package info (click to toggle)
gss 1.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,232 kB
  • ctags: 2,436
  • sloc: sh: 13,069; ansic: 11,900; python: 2,873; perl: 623; makefile: 172; sed: 16
file content (52 lines) | stat: -rw-r--r-- 1,958 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gss_encapsulate_token" 3 "1.0.3" "gss" "gss"
.SH NAME
gss_encapsulate_token \- API function
.SH SYNOPSIS
.B #include <gss.h>
.sp
.BI "extern OM_uint32 gss_encapsulate_token(gss_const_buffer_t " input_token ", gss_const_OID " token_oid ", gss_buffer_t " output_token ");"
.SH ARGUMENTS
.IP "gss_const_buffer_t input_token" 12
(buffer, opaque, read) Buffer with GSS\-API context token data.
.IP "gss_const_OID token_oid" 12
(Object ID, read) Object identifier of token.
.IP "gss_buffer_t output_token" 12
(buffer, opaque, modify) Encapsulated token data;
  caller must release with \fBgss_release_buffer()\fP.
.SH "DESCRIPTION"
Add the mechanism\-independent token header to GSS\-API context token
data.  This is used for the initial token of a GSS\-API context
establishment sequence.  It incorporates an identifier of the
mechanism type to be used on that context, and enables tokens to be
interpreted unambiguously at GSS\-API peers.  See further section
3.1 of RFC 2743.  This function is standardized in RFC 6339.
.SH "RETURNS"

`GSS_S_COMPLETE`: Indicates successful completion, and that output
parameters holds correct information.

`GSS_S_FAILURE`: Indicates that encapsulation failed for reasons
unspecified at the GSS\-API level.
.SH "REPORTING BUGS"
Report bugs to <bug-gss@gnu.org>.
GNU Generic Security Service home page: http://www.gnu.org/software/gss/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2003-2013 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gss
is maintained as a Texinfo manual.  If the
.B info
and
.B gss
programs are properly installed at your site, the command
.IP
.B info gss
.PP
should give you access to the complete manual.