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

FreeBSD Manual Pages

  
 
  

home | help
Cutelyst4Qt6Session(5)	      File Formats Manual	Cutelyst4Qt6Session(5)

NAME
       Cutelyst4Qt6Session  -  Configuration  of  the  Session	Plugin for the
       Cutelyst	Web Framework

DESCRIPTION
       The Session plugin for Cutelyst can be used to generate	user  sessions
       that  are  stored on the	server side in a session store and on the user
       side in a session cookie. The name of the session cookie	is the name of
       the application + "_session".

CONFIGURATION
       The Session plugin can be configured in the Cutelyst  application  con-
       figuration file in the Cutelyst_Session_Plugin section.

       expires (integer	or string value, default: 2 hours)
	   The	expiration  duration of	the session. Can be given as time span
	   where the following time units are understood:

	      usec, us

	      msec, ms

	      seconds,	second,	sec, s

	      minutes,	minute,	min, m

	      hours, hour, hr,	h

	      days, day, d

	      weeks, week, w

	      months, month, M	(defined as 30.44 days)

	      years, year, y (defined as 365.25 days)

	   If no time unit is specified, generally seconds are assumed.	 Exam-
	   ples	for valid time span specifications:

	       2 h
	       2hours
	       48hr
	       1y 12month
	       55s500ms
	       300ms20s	5day

       verify_address (boolean value, default: false)
	   If enabled, the plugin will check if	the IP address of the request-
	   ing user matches the	address	stored in the session data. In case of
	   a mismatch, the session will	be deleted.

       verify_user_agent (boolean value, default: false)
	   If  true, the plugin	will check if the user agent of	the requesting
	   user	matches	the user agent stored in the session data. In case  of
	   a mismatch, the session will	be deleted.

       cookie_http_only	(boolean value,	default: true)
	   If true, the	session	cookie will have the httpOnly flag set so that
	   the cookie is not accessible	to JavaScript's	Document.cookie	API.

       cookie_secure (boolean value, default: false)
	   If  true,  the session cookie will have the secure flag set so that
	   the cookie is only sent to the server  with	an  encrypted  request
	   over	the HTTPS protocol.

EXAMPLES
       [Cutelyst_Session_Plugin]
       expires="1 hour"

LOGGING	CATEGORY
       cutelyst.plugin.session

SEE ALSO
       Cutelyst4Qt6MemcachedSessionStore(5)

Cutelyst4Qt6Session 4.5.0	  2023-12-01		Cutelyst4Qt6Session(5)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=Cutelyst4Qt6Session&sektion=5&manpath=FreeBSD+Ports+14.3.quarterly>

home | help