---
name: "RT::Authen::ExternalAuth::DBI::Cookie"
section: "3pm"
platform: "linux"
package: "rt4-extension-authenexternalauth"
version: "0.25-1+deb8u1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/RT::Authen::ExternalAuth::DBI::Cookie"
---

# RT::Authen::ExternalAuth::DBI::Cookie(3pm)

Database-backed, cookie SSO source for RT authentication

## NAME

RT::Authen::ExternalAuth::DBI::Cookie - Database-backed, cookie SSO source for RT authentication

## DESCRIPTION

Provides the Cookie implementation for RT::Authen::ExternalAuth.

## SYNOPSIS

Set($ExternalSettings, {\
     \# An example SSO cookie service\
     'My\_SSO\_Cookie'  =\> {\
         'type'                      =\>  'cookie',\
         'name'                      =\>  'loginCookieValue',\
         'u\_table'                   =\>  'users',\
         'u\_field'                   =\>  'username',\
         'u\_match\_key'               =\>  'userID',\
         'c\_table'                   =\>  'login\_cookie',\
         'c\_field'                   =\>  'loginCookieValue',\
         'c\_match\_key'               =\>  'loginCookieUserID',\
         'db\_service\_name'           =\>  'My\_MySQL'\
     },\
     'My\_MySQL' =\> {\
         ...\
     }, } );

## CONFIGURATION

Cookie-specific options are described here. Shared options are described in the *etc/RT\_SiteConfig.pm* file included in this distribution.

The example in the "SYNOPSIS" lists all available options and they are described below.

- name

  The name of the cookie to be used.

- u\_table

  The users table.

- u\_field

  The username field in the users table.

- u\_match\_key

  The field in the users table that uniquely identifies a user and also exists in the cookies table. See c\_match\_key below.

- c\_table

  The cookies table.

- c\_field

  The field that stores cookie values.

- c\_match\_key

  The field in the cookies table that uniquely identifies a user and also exists in the users table. See u\_match\_key above.

- db\_service\_name

  The DB service in this configuration to use to lookup the cookie information. See RT::Authen::ExternalAuth::DBI.