Hallo, dies ist ein Test.

PWD: /www/data-lst1/unixsoft/unixsoft/kaempfer/.public_html

Running in File Mode
Relative path: ././../../../../../../usr/man/man3rad/authentication-1.3rad
Real path: /usr/share/man/man3rad/authentication-1.3rad
Zurück

'\" t
.\"     Title: authentication-1
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 2018-09-05
.\"    Manual: RAD Module Definitions
.\"    Source: Solaris 11.4
.\"  Language: English
.\"
.TH "AUTHENTICATION\-1" "3rad" "2018\-09\-05" "Solaris 11.4" "RAD Module Definitions"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
authentication \- API for token\-based authentication
.SH "SYNOPSIS"
.nf
#include <rad/client/1/authentication\&.h>
cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-lauthentication1_client\fR [ library\&.\&.\&. ]
.fi
.SS "interface Session"
.nf
const char *\ \&user\ \&; (ro)
.fi
.nf
const char **\ \&roles\ \&; (ro)
.fi
.nf
const char *\ \&token\ \&; (rw)
.fi
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_create\fR('u
.R rc_err_t \fBauthentication_Session__rad_create\fR(rc_instance_t\ *inst, 
.
const\ char\ *username, 
.
const\ char\ *password, 
.
const\ char\ *scheme, 
.
boolean_t\ preserve, 
.
long\ long\ timeout, 
.
rc_instance_t\ **result);
.RS
.RE
.fi
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_delete\fR('u
.R rc_err_t \fBauthentication_Session__rad_delete\fR(rc_instance_t\ *inst);
.RS
.RE
.fi
.SH "DESCRIPTION"
.PP
\fBAPI com\&.oracle\&.solaris\&.rad\&.authentication \fR\fB\&\s-2\u[1]\d\s+2\fR
.PP
This API provides functions for generating and redeeming security tokens for RAD\'s token\-based Authentication\&.
.SH "INTERFACES"
.SS "interface Session"
.PP
Session interface\&. Represents a session within RAD\&. Clients should interact with this interface to: \- authenticate and obtain access to RAD \- retrieve, redeem and revoke UUID authentication tokens \- obtain information about existing sessions \- delete sessions \- obtain session specific data, user, roles\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSession Properties\fR
.RS 4
.PP
\fB\fIconst char *\fR\fR\ \&\fBuser\fR
(\fIread\-only\fR, \fInullable\fR) \(em gets the username of the connected user
.\" blockquote {
.RS 4
.nf
.HP \w'rc_err_t\ \fBauthentication_Session_get_user\fR('u
.R rc_err_t \fBauthentication_Session_get_user\fR(rc_instance_t\ *inst, 
.
char\ **result);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Get property value\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fIresult\fR
\(em Property value returned
.RE
.\" } blockquote
.RE
.\" } blockquote
.PP
\fB\fIconst char **\fR\fR\ \&\fBroles\fR
(\fIread\-only\fR) \(em gets the list of roles available to the connected user
.\" blockquote {
.RS 4
.nf
.HP \w'rc_err_t\ \fBauthentication_Session_get_roles\fR('u
.R rc_err_t \fBauthentication_Session_get_roles\fR(rc_instance_t\ *inst, 
.
char\ ***result, 
.
int\ *result_cnt);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Get property value\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fIresult\fR
\(em Property value returned
.PP
\fIresult_cnt\fR
\(em Number of items in result array
.RE
.\" } blockquote
.RE
.\" } blockquote
.PP
\fB\fIconst char *\fR\fR\ \&\fBtoken\fR
(\fIread\-write\fR, \fInullable\fR) \(em Read/Write the session\'s token\&.
.\" blockquote {
.RS 4
.nf
.HP \w'rc_err_t\ \fBauthentication_Session_get_token\fR('u
.R rc_err_t \fBauthentication_Session_get_token\fR(rc_instance_t\ *inst, 
.
char\ **result);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Get property value\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fIresult\fR
\(em Property value returned
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBauthentication_Session_set_token\fR('u
.R rc_err_t \fBauthentication_Session_set_token\fR(rc_instance_t\ *inst, 
.
const\ char\ *token);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Set property value\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fItoken\fR
\(em Property value written
.RE
.\" } blockquote
.RE
.\" } blockquote
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSession Create\fR
.RS 4
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_create\fR('u
.R rc_err_t \fBauthentication_Session__rad_create\fR(rc_instance_t\ *inst, 
.
const\ char\ *username, 
.
const\ char\ *password, 
.
const\ char\ *scheme, 
.
boolean_t\ preserve, 
.
long\ long\ timeout, 
.
rc_instance_t\ **result);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Create a new Session instance\&. If authentication data cannot be validated by the server an error is raised\&. For HTTP clients, a secure token is returned in the HTTP cookie\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fIusername\fR
.PP
\fIpassword\fR
.PP
\fIscheme\fR
\(em Sets the authentication scheme\&. Currently only \'pam\' supported\&.
.PP
\fIpreserve\fR
.PP
\fItimeout\fR
\(em Timeout in minutes\&. If timeout is specified as \-1, the default session timeout for this REST interfaces is 60 minutes\&.
.PP
\fIresult\fR
\(em New Session instance
.RE
.\" } blockquote
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSession Retrieve\fR
.RS 4
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_get_name\fR('u
.R rc_err_t \fBauthentication_Session__rad_get_name\fR(adr_name_t\ **result, 
.
int\ n, 
.
\&.\&.\&.);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Obtain RAD name of a Session object\&.
.PP
\fBArguments:\fR
.PP
\fIresult\fR
\(em RAD name
.PP
\fIn\fR
\(em Number of key\-value pairs provided as variadic arguments
.PP
\&.\&.\&. \(em Optional key\-value pairs that compose the primary key
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_lookup\fR('u
.R rc_err_t \fBauthentication_Session__rad_lookup\fR(rc_conn_t\ *c, 
.
boolean_t\ strict, 
.
rc_instance_t\ **result, 
.
int\ n, 
.
\&.\&.\&.);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Lookup a Session instance\&.
.PP
Construct a RAD name for the interface based on the provided key\-value pairs and perform a lookup\&. If successful, instance reference is returned in the result\&.
.PP
\fBArguments:\fR
.PP
\fIc\fR
\(em RAD connection handle
.PP
\fIstrict\fR
\(em Strict (B_TRUE) or relaxed (B_FALSE) versioning
.PP
\fIresult\fR
\(em RAD instance
.PP
\fIn\fR
\(em Number of key\-value pairs provided as variadic arguments
.PP
\&.\&.\&. \(em Optional key\-value pairs that compose the primary key
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_list\fR('u
.R rc_err_t \fBauthentication_Session__rad_list\fR(rc_conn_t\ *c, 
.
boolean_t\ strict, 
.
adr_pattern_scheme_t\ scheme, 
.
adr_name_t\ ***result, 
.
int\ *result_count, 
.
int\ n, 
.
\&.\&.\&.);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
List RAD names of a available Session instances\&.
.PP
Returns an array and array size of matching object names\&.
.PP
\fBArguments:\fR
.PP
\fIc\fR
\(em RAD connection handle
.PP
\fIstrict\fR
\(em Strict (B_TRUE) or relaxed (B_FALSE) versioning
.PP
\fIscheme\fR
\(em Apply glob (NS_GLOB) or regex (NS_REGEX) matching
.PP
\fIresult\fR
\(em Array of RAD names
.PP
\fIresult_count\fR
\(em Number of names in result array
.PP
\fIn\fR
\(em Number of key\-value pairs provided as variadic arguments
.PP
\&.\&.\&. \(em Optional key\-value pairs that compose the primary key
.RE
.\" } blockquote
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSession Delete\fR
.RS 4
.nf
.HP \w'rc_err_t\ \fBauthentication_Session__rad_delete\fR('u
.R rc_err_t \fBauthentication_Session__rad_delete\fR(rc_instance_t\ *inst);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Delete and disconnect current session\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.RE
.\" } blockquote
.RE
.SH "VERSION"
.PP
1\&.0
.SH "ATTRIBUTES"
.PP
See attributes(7) for descriptions of the following attributes:
.TS
allbox tab(:);
cB cB.
T{
ATTRIBUTE TYPE
T}:T{
ATTRIBUTE VALUE
T}
.T&
l l
l l.
T{
Availability
T}:T{
system/management/rad
T}
T{
Interface Stability
T}:T{
Private
T}
.TE
.sp 1
.SH "SEE ALSO"
.PP
\fBrad\fR(8)
.SH "NOTES"
.IP " 1." 4
Accessing Python documentation for this module:
.sp
.RS 4
.nf
$ pydoc rad.bindings.com.oracle.solaris.rad.authentication_1
.fi
.RE