.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Bio::Graphics::Browser2::Plugin::AuthPlugin 3pm"
.TH Bio::Graphics::Browser2::Plugin::AuthPlugin 3pm "2018-10-03" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Bio::Graphics::Browser2::Plugin::AuthPlugin \-\- Base class for authentication plugins
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& package Bio::Graphics::Browser2::Plugin::MyPlugin;
\& use base \*(AqBio::Graphics::Browser2::Plugin::AuthPlugin\*(Aq;
\&
\& sub authenticate {
\&     my $self = shift;
\&     my ($user,$password) = $self\->credentials;
\&     return unless  $user eq \*(Aqgeorge\*(Aq && $password eq \*(Aqwashington\*(Aq;
\&     return ($user,\*(AqGeorge Washington\*(Aq,\*(Aqgeorge@whitehouse.gov\*(Aq);
\& }
\&
\& sub user_in_group {
\&     my $self = shift;
\&     my ($user,$group) = @_;
\&     return $user eq \*(Aqgeorge\*(Aq && $group eq \*(Aqpotomac\*(Aq;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a template for authorizer plugins. To define a new type of
authorizer, you need only inherit from this class and define an
\&\fIauthenticate()\fR method. This method takes two arguments: the username
and password and returns an empty list if authentication fails, or a 
list of (username, fullname, email) if authentication succeeds (fullname
and email are optional).
.PP
In addition, you may override the \fIuser_in_group()\fR method, which takes
two argumetns: the username and group. Return true if the user belongs
to the group, and false otherwise.
.PP
Other methods you may wish to override include:
.PP
.Vb 5
\& * authentication_hint()
\& * authentication_help()
\& * configure_form()
\& * reconfigure()
\& * credentials()
.Ve
.PP
These are described below.
.SS "Methods you will need to override"
.IX Subsection "Methods you will need to override"
.ie n .IP "$boolean = $plugin\->authenticate($username,$password)" 4
.el .IP "\f(CW$boolean\fR = \f(CW$plugin\fR\->authenticate($username,$password)" 4
.IX Item "$boolean = $plugin->authenticate($username,$password)"
Return true if username and password are correct. False otherwise.
.ie n .IP "$boolean = $plugin\->user_in_group($username,$groupname)" 4
.el .IP "\f(CW$boolean\fR = \f(CW$plugin\fR\->user_in_group($username,$groupname)" 4
.IX Item "$boolean = $plugin->user_in_group($username,$groupname)"
Return true if user belongs to group. False otherwise.
.SS "Methods that you may want to customize"
.IX Subsection "Methods that you may want to customize"
.ie n .IP "$message = $plugin\->authentication_hint" 4
.el .IP "\f(CW$message\fR = \f(CW$plugin\fR\->authentication_hint" 4
.IX Item "$message = $plugin->authentication_hint"
Returns a message printed at the top of the login dialog, that will
help the user know which credentials he is expected to present. For
example, returning \*(L"Acme Corp Single Sign-on\*(R" will present the user
with \*(L"Please log into your Acme Corp Single Sign-on\*(R".
.Sp
The default behavior is to take this value from the \*(L"login hint\*(R"
option in a stanza named [AuthPlugin:plugin]. Example:
.ie n .IP "$message = $plugin\->authentication_help" 4
.el .IP "\f(CW$message\fR = \f(CW$plugin\fR\->authentication_help" 4
.IX Item "$message = $plugin->authentication_help"
Returns a message printed at the bottom of the login dialog. It is 
expected to be used for a help message or link that will give the user
help with logging in. For example, it can take him to a link to reset
his password.
.Sp
The default behavior is to take this value from the \*(L"login help\*(R"
option in a stanza named [AuthPlugin:plugin].
.Sp
.Vb 3
\&  [AuthPlugin:plugin]
\&  login hint = your Acme Corp Single Sign\-on Account
\&  login help = <a href="www.acme.com/passwd_help">Recover forgotten password</a>
.Ve
.SS "Methods that you may want to override"
.IX Subsection "Methods that you may want to override"
.ie n .IP "$html = $plugin\->\fIconfigure_form()\fR" 4
.el .IP "\f(CW$html\fR = \f(CW$plugin\fR\->\fIconfigure_form()\fR" 4
.IX Item "$html = $plugin->configure_form()"
This method returns the contents of the login form. The default
behavior is to produce two text fields, one named 'name' and the
other named 'password'.
.ie n .IP "$plugin\->\fIreconfigure()\fR" 4
.el .IP "\f(CW$plugin\fR\->\fIreconfigure()\fR" 4
.IX Item "$plugin->reconfigure()"
This method is called to copy the values from the filled-out form into
the plugin's hash of configuration variables. If you add fields to
\&\fIconfigure_form()\fR will you need to adjust this method as well.
.ie n .IP "$plugin\->\fIconfig_defaults()\fR" 4
.el .IP "\f(CW$plugin\fR\->\fIconfig_defaults()\fR" 4
.IX Item "$plugin->config_defaults()"
Set up defaults for the configuration hash. Use this if you wish to
default to a particular username.
.ie n .IP "$plugin\->\fIcredentials()\fR" 4
.el .IP "\f(CW$plugin\fR\->\fIcredentials()\fR" 4
.IX Item "$plugin->credentials()"
This returns a two-element list containing the username and password
last entered into the authentication dialog. It reads these values
from the configuration hash returned by \f(CW$self\fR\->\fIconfiguration()\fR.
If you add additional types of credentials to the login dialog, you 
may need to override this method.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Bio::Graphics::Browser2
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com<gt>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL\s0 (either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.