From 0ccb37359517e553ecf28c2e001c4f3c85e8fcfb Mon Sep 17 00:00:00 2001 From: Paul Cochrane Date: Sun, 3 May 2015 10:49:03 +0200 Subject: [PATCH 1/2] Correct typographical errors in POD --- lib/RT/Authen/ExternalAuth.pm | 14 +++++++------- lib/RT/Authen/ExternalAuth/DBI.pm | 10 +++++----- lib/RT/Authen/ExternalAuth/DBI/Cookie.pm | 2 +- lib/RT/Authen/ExternalAuth/LDAP.pm | 6 +++--- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/lib/RT/Authen/ExternalAuth.pm b/lib/RT/Authen/ExternalAuth.pm index d4dc8dd..0a98413 100644 --- a/lib/RT/Authen/ExternalAuth.pm +++ b/lib/RT/Authen/ExternalAuth.pm @@ -11,7 +11,7 @@ RT::Authen::ExternalAuth - RT Authentication using External Sources This module provides the ability to authenticate RT users against one or more external data sources at once. It will also allow information about that user to be loaded from the same, or any other available, source as -well as allowing multple redundant servers for each method. +well as allowing multiple redundant servers for each method. The extension currently supports authentication and information from LDAP via the Net::LDAP module, and from any data source that an @@ -75,7 +75,7 @@ plugin root. =head1 CONFIGURATION L provides a lot of flexibility with many -configuration options. The following desc these configuration options, +configuration options. The following describes these configuration options, and provides a complete example. =over 4 @@ -91,7 +91,7 @@ using C, remove C and C. Set($ExternalAuthPriority, [ 'My_LDAP', 'My_MySQL', - 'My_SSO_Cookie' + 'My_SSO_Cookie', ] ); @@ -105,7 +105,7 @@ disabled. Once a user record is found, no more services are checked. -You CANNOT use a SSO cookie to retrieve information. +You CANNOT use an SSO cookie to retrieve information. You should remove services you don't use, but you must define at least one service. @@ -127,7 +127,7 @@ email to a support email address. These are the full settings for each external service as a hash of hashes. Note that you may have as many external services as you wish. -They will be checked in the order specified in L +They will be checked in the order specified in the L and L directives above. The outer structure is a key with the authentication option (name of @@ -193,7 +193,7 @@ C or building name). =item attr_map -Mapping of RT attributes on to attributes in the external source. +Mapping of RT attributes onto attributes in the external source. Valid keys are attributes of an L. The values are attributes from your authentication source. @@ -220,7 +220,7 @@ For example, an LDAP mapping might look like: # Users created from LDAP should be Privileged; this is a core RT # option. Additionally, this is the 4.2 name for the option; for RT - # 4.0, is it named $AutoCreate See the core RT documentation at + # 4.0, is it named $AutoCreate. See the core RT documentation at # http://docs.bestpractical.com/RT_Config#UserAutocreateDefaultsOnLogin # for for further details. Set( $UserAutocreateDefaultsOnLogin, { Privileged => 1 } ); diff --git a/lib/RT/Authen/ExternalAuth/DBI.pm b/lib/RT/Authen/ExternalAuth/DBI.pm index 3fe6cda..7fc4f5a 100644 --- a/lib/RT/Authen/ExternalAuth/DBI.pm +++ b/lib/RT/Authen/ExternalAuth/DBI.pm @@ -63,8 +63,8 @@ DBI-specific options are described here. Shared options are described in the F file included in this distribution. -The example in the L lists all available options -and they are described below. See the L module for details +The example in the L lists all available options; +they are also described below. See the L module for details on debugging connection issues. =over 4 @@ -99,16 +99,16 @@ The database table containing the user information to check against. =item u_field -The field in the table that holds usernames +The field in the table that holds usernames. =item p_field -The field in the table that holds passwords +The field in the table that holds passwords. =item p_check Optional. An anonymous subroutine definition used to check the (presumably -hashed) passed from the database with the password entered by the user logging +hashed) password from the database with the password entered by the user logging in. The subroutine should return true on success and false on failure. The configuration options C and C will be ignored when C is defined. diff --git a/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm b/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm index dee7146..f2abb9e 100644 --- a/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm +++ b/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm @@ -39,7 +39,7 @@ are described in the F file included in this distribution. The example in the L lists all available options -and they are described below. +as well as being described below. =over 4 diff --git a/lib/RT/Authen/ExternalAuth/LDAP.pm b/lib/RT/Authen/ExternalAuth/LDAP.pm index 912e8e6..c716b5a 100644 --- a/lib/RT/Authen/ExternalAuth/LDAP.pm +++ b/lib/RT/Authen/ExternalAuth/LDAP.pm @@ -63,8 +63,8 @@ LDAP-specific options are described here. Shared options are described in the F file included in this distribution. -The example in the L lists all available options -and they are described below. Note that many of these values +The example in the L lists all available options; +they are also described below. Note that many of these values are specific to LDAP, so you should consult your LDAP documentation for details. @@ -79,7 +79,7 @@ The server hosting the LDAP or AD service. The username and password RT should use to connect to the LDAP server. -If you can bind to your LDAP server anonymously you may be able to omit these +If you can bind to your LDAP server anonymously, you may be able to omit these options. Many servers do not allow anonymous binds, or restrict what information they can see or how much information they can retrieve. If your server does not allow anonymous binds then you must have a service account created for this From 121a0faa4ad5f766ffd04173bb9779afa75ab6cd Mon Sep 17 00:00:00 2001 From: Paul Cochrane Date: Sun, 3 May 2015 10:53:14 +0200 Subject: [PATCH 2/2] Add some formatting to POD for extra clarity Essentially this change only adds C<> formatting tags around elements which are code or paths in order to highlight that the elements are code or code-like elements. --- lib/RT/Authen/ExternalAuth.pm | 4 ++-- lib/RT/Authen/ExternalAuth/DBI.pm | 2 +- lib/RT/Authen/ExternalAuth/DBI/Cookie.pm | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/RT/Authen/ExternalAuth.pm b/lib/RT/Authen/ExternalAuth.pm index 0a98413..59508fc 100644 --- a/lib/RT/Authen/ExternalAuth.pm +++ b/lib/RT/Authen/ExternalAuth.pm @@ -14,7 +14,7 @@ that user to be loaded from the same, or any other available, source as well as allowing multiple redundant servers for each method. The extension currently supports authentication and information from -LDAP via the Net::LDAP module, and from any data source that an +LDAP via the C module, and from any data source that an installed DBI driver is available for. It is also possible to use cookies set by an alternate application for @@ -68,7 +68,7 @@ You may not have all of these files. It depends what versions you are upgrading between. If you are using a vendor packaged RT, your local directories are likely -to be somewhere under /usr/local instead of in /opt/rt4 so you will need +to be somewhere under C instead of in C so you will need to visit Configuration -> Tools -> System Configuration to find your plugin root. diff --git a/lib/RT/Authen/ExternalAuth/DBI.pm b/lib/RT/Authen/ExternalAuth/DBI.pm index 7fc4f5a..7325ce1 100644 --- a/lib/RT/Authen/ExternalAuth/DBI.pm +++ b/lib/RT/Authen/ExternalAuth/DBI.pm @@ -135,7 +135,7 @@ load in your Perl installation. =item p_salt -If p_enc_sub takes a salt as a second parameter then set it here. +If C takes a salt as a second parameter then set it here. =item d_field, d_values diff --git a/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm b/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm index f2abb9e..ebc97cf 100644 --- a/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm +++ b/lib/RT/Authen/ExternalAuth/DBI/Cookie.pm @@ -58,7 +58,7 @@ The username field in the users table. =item 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. +and also exists in the cookies table. See C below. =item c_table @@ -71,7 +71,7 @@ The field that stores cookie values. =item 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. +and also exists in the users table. See C above. =item db_service_name