Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
OpenXPKI::Server::SessUser3Contributed Perl DocumeOpenXPKI::Server::Session(3)


       This module implements the complete session mechanism for the OpenXPKI
       core code. This include some mechanisms to support the authentication
       phase which means that it is possible to	operate	a session in a mode
       which is	not valid.


       This function creates a new or load an already existing session.	 It
       supports	the following parameters:

       o   LIFETIME [seconds]

       o   DIRECTORY [path to "cookie" area]

       o   ID [session ID]


       This function is	called without any argument and	simply removes the
       session.	This is	required on failed authentications. Please note	that
       the behaviour of	an object refrence after a call	to delete is
       completeley undefined. Simply drop any references to a session object
       after you call delete on	it.

   Status Management (authentication support)

       sets the	status of the session to authentication	mode.


       sets the	status of the session to valid.


       returns 1 if it is a valid session and 0	if the session is not valid.


       sets a challenge	string.	This is	useful for authentication tasks	if the
       session is not valid.


       returns a challenge string if such a string was set in the past.

   Session persistence
       The session module supports persistence across the lifetime of the
       originating process. You	can use	"export_serialized_info" to get	a hash
       representing the	current	state of the session and
       "import_serialized_info"	to make	a new session impersonate those	state.
       You can define what keys	are persisted in "_get_persitence_keys".

       _get_persitence_keys Returns the	keys that should be used when
       persisting the session. Currently the fields are	user role

       export_serialized_info Return a key/value hash with the keys named in


       Pass a string with the serialized info as obtained by
       export_serialized_info.	The parameters overwrite the current session
       settings. You can add a hash a second parameter with skip_variable_name
       =\ 1> to	skip certain values.


       Parse a serialized session blob and return as hash.

   Set/Get functions
       o   set_user

       o   get_user

       o   set_role

       o   get_role

       o   set_pki_realm

       o   get_pki_realm

       o   get_id

       o   get_language

       o   set_language

       o   get_secret

       o   set_secret

       o   get_state

       o   set_state

       o   delete_secret

perl v5.24.1			  2017-07-03	  OpenXPKI::Server::Session(3)

Name | Description | Function

Want to link to this manual page? Use this URL:

home | help