Lemonldap/NG/Handler/Lib/SecureToken.pm

filter: Statementstmt 17.1% 18 / 105 Branchbran 0.0% 0 / 34 Conditioncond 0.0% 0 / 18 MC/DCmcdc 0.0% 0 / 10 Subroutinesub 41.6% 5 / 12 Podpod 0.0% 0 / 1 totaltotal 12.7% 23 / 180 CC 28 SCAR 51.5
CC
28
Cov
11%
run
345.1
_isAlive
20.0
__ANON__
12.0
CRAP 172.8
↑ Summary Lemonldap/NG/SSOaaS/Apache/Client.pm »
1 ##@file
2 # Secure Token
3  
4 ##@class
5 # Secure Token
6 #
7 # Create a secure token used to resolve user identity by a protected application
8  
9 package Lemonldap::NG::Handler::Lib::SecureToken;
10  
11 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
12 1 ▶use Cache::Memcached;
Subroutine BEGIN: called CC=1 SCAR=0.0
13 1 ▶use Apache::Session::Generate::MD5;
Subroutine BEGIN: called CC=1 SCAR=0.0
14  
15 1 our $VERSION = '2.21.0';
16  
17 # Shared variables
18 1 our $secureTokenMemcachedConnection;
19  
20 1 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
21 1 eval {
22 1 require threads::shared;
23 1 threads::share($secureTokenMemcachedConnection);
24 };
25 }
26  
27 ## @rmethod Apache2::Const run(Apache2::RequestRec r)
28 # Overload main run method
29 # @param r Current request
30 # @return Apache2::Const value ($class->OK, $class->FORBIDDEN, $class->REDIRECT or $class->SERVER_ERROR)
31 0 ▶sub run {
Subroutine run: not called CC=19 SCAR=58.4
Pod undocumented
32 0 my $class = shift;
33 0 my $r = shift;
34 0 my ( $ret, $session ) = $class->Lemonldap::NG::Handler::Main::run($r);
35  
36 # Continue only if user is authorized
37 0 ▶ return $ret unless ( $ret == $class->OK );
Branch: 1 branch
BranchTrueFalseTotal
unless $ret == $class->OK 0 0 0
38  
39 # Get current URI
40 0 my $uri = $r->access_control_uri;
41  
42 # Catch Secure Token parameters
43 0 my $localConfig = $class->localConfig;
44 our $secureTokenMemcachedServers =
45 0 ▶ $localConfig->{secureTokenMemcachedServers} || ['127.0.0.1:11211'];
Condition0%0/2
$localConfig->{'secureTokenMemcachedServers'} || ['127.0.0.1:11211']
l!l
00
MC/DC0%0/1
$localConfig->{'secureTokenMemcachedServers'} || ['127.0.0.1:11211']
$localConfig->{'secureTokenMemcachedServers'}
Truth table0%0/2
A
A= $localConfig->{'secureTokenMemcachedServers'}
Aresult
11
00
46 0 ▶ my $secureTokenExpiration = $localConfig->{secureTokenExpiration} || 60;
Condition0%0/2
$localConfig->{'secureTokenExpiration'} || 60
l!l
00
MC/DC0%0/1
$localConfig->{'secureTokenExpiration'} || 60
$localConfig->{'secureTokenExpiration'}
Truth table0%0/2
A
A= $localConfig->{'secureTokenExpiration'}
Aresult
11
00
47 0 ▶ my $secureTokenAttribute = $localConfig->{secureTokenAttribute} || 'uid';
Condition0%0/2
$localConfig->{'secureTokenAttribute'} || 'uid'
l!l
00
MC/DC0%0/1
$localConfig->{'secureTokenAttribute'} || 'uid'
$localConfig->{'secureTokenAttribute'}
Truth table0%0/2
A
A= $localConfig->{'secureTokenAttribute'}
Aresult
11
00
48 0 ▶ our $secureTokenUrls = $localConfig->{'secureTokenUrls'} || ['.*'];
Condition0%0/2
$localConfig->{'secureTokenUrls'} || ['.*']
l!l
00
MC/DC0%0/1
$localConfig->{'secureTokenUrls'} || ['.*']
$localConfig->{'secureTokenUrls'}
Truth table0%0/2
A
A= $localConfig->{'secureTokenUrls'}
Aresult
11
00
49 0 ▶ my $secureTokenHeader = $localConfig->{secureTokenHeader} || 'Auth-Token';
Condition0%0/2
$localConfig->{'secureTokenHeader'} || 'Auth-Token'
l!l
00
MC/DC0%0/1
$localConfig->{'secureTokenHeader'} || 'Auth-Token'
$localConfig->{'secureTokenHeader'}
Truth table0%0/2
A
A= $localConfig->{'secureTokenHeader'}
Aresult
11
00
50 0 ▶ my $secureTokenAllowOnError = $localConfig->{'secureTokenAllowOnError'}
Condition0%0/2
$localConfig->{"secureTokenAllowOnError"} // 1
l!l
00
MC/DC0%0/1
$localConfig->{"secureTokenAllowOnError"} // 1
$localConfig->{"secureTokenAllowOnError"}
Truth table0%0/2
A
A= $localConfig->{"secureTokenAllowOnError"}
Aresult
11
00
51 // 1;
52  
53 # Force some parameters to be array references
54 0 foreach (qw/secureTokenMemcachedServers secureTokenUrls/) {
55 1 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
56 0 ▶ unless ( ref ${$_} eq "ARRAY" ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (ref ${$_;} eq "ARRAY") 0 0 0
57 0 $class->logger->debug("Transform $_ value into an array reference");
58 0 my @array = split( /\s+/, ${$_} );
59 0 ${$_} = \@array;
60 }
61 }
62  
63 # Display found values in debug mode
64 0 $class->logger->debug( 'secureTokenMemcachedServers: ' . join ', ',
65 @$secureTokenMemcachedServers );
66 0 $class->logger->debug("secureTokenExpiration: $secureTokenExpiration");
67 0 $class->logger->debug("secureTokenAttribute: $secureTokenAttribute");
68 0 $class->logger->debug( 'secureTokenUrls: ' . join ', ', @$secureTokenUrls );
69 0 $class->logger->debug("secureTokenHeader: $secureTokenHeader");
70 0 $class->logger->debug("secureTokenAllowOnError: $secureTokenAllowOnError");
71  
72 # Return if we are not on a secure token URL
73 0 my $checkurl;
74 0 foreach (@$secureTokenUrls) {
75 0 ▶ if ( $uri =~ m#$_# ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($uri =~ /$_/) 0 0 0
76 0 $checkurl = 1;
77 0 $class->logger->debug(
78 "URL $uri detected as an SecureToken URL (rule: $_)");
79 0 last;
80 }
81 }
82 0 ▶ return $class->OK unless $checkurl;
Branch: 1 branch
BranchTrueFalseTotal
unless $checkurl 0 0 0
83  
84 # Test Memcached connection
85 0 ▶ unless ( $class->_isAlive() ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($class->_isAlive) 0 0 0
86 0 $secureTokenMemcachedConnection =
87 $class->_createMemcachedConnection($secureTokenMemcachedServers);
88 }
89  
90 # Exit if no connection
91 0 ▶ return $class->_returnError( $r, $secureTokenAllowOnError )
Branch: 1 branch
BranchTrueFalseTotal
unless $class->_isAlive 0 0 0
92 unless $class->_isAlive();
93  
94 # Value to store
95 0 my $value = $class->data->{$secureTokenAttribute};
96  
97 # Set token
98 0 my $key = $class->_setToken( $value, $secureTokenExpiration );
99 0 ▶ return $class->_returnError( $r, $secureTokenAllowOnError ) unless $key;
Branch: 1 branch
BranchTrueFalseTotal
unless $key 0 0 0
100  
101 # Header location
102 0 $class->set_header_in( $r, $secureTokenHeader => $key );
103  
104 # Remove token
105 0 ▶ eval 'use Apache2::Filter' unless ( $INC{"Apache2/Filter.pm"} );
Branch: 1 branch
BranchTrueFalseTotal
unless $INC{"Apache2/Filter.pm"} 0 0 0
106  
107 0 ▶ if ( $INC{"Apache2/Filter.pm"} and defined $r->{env}->{'psgi.r'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($INC{"Apache2/Filter.pm"} and defined $r->{"env"}{"psgi.r"}) 0 0 0
Condition0%0/3
$INC{"Apache2/Filter.pm"} and defined $r->{"env"}{"psgi.r"}
!ll&&!rl&&r
000
MC/DC0%0/2
$INC{"Apache2/Filter.pm"} and defined $r->{"env"}{"psgi.r"}
$INC{"Apache2/Filter.pm"} defined $r->{"env"}{"psgi.r"}
Truth table0%0/3
A and B
A= $INC{"Apache2/Filter.pm"}B= defined $r->{"env"}{"psgi.r"}
ABresult
0X0
100
111
108 $r->{env}->{'psgi.r'}->add_output_filter(
109 0 ▶ sub {
Subroutine __ANON__: not called CC=3 SCAR=24.8
110 0 my $f = shift;
111 0 ▶ while ( $f->read( my $buffer, 1024 ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($f->read(my $buffer, 1024)) 0 0 0
112 0 $f->print($buffer);
113 }
114 0 ▶ if ( $f->seen_eos ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($f->seen_eos) 0 0 0
115 0 $class->_deleteToken($key);
116 }
117 0 return $class->OK;
118 }
119 0 );
120 }
121  
122 0 return $class->OK;
123 }
124  
125 ## @method private Cache::Memcached _createMemcachedConnection(ArrayRef secureTokenMemcachedServers)
126 # Create Memcached connexion
127 # @param $secureTokenMemcachedServers Memcached servers
128 # @return Cache::Memcached object
129 0 ▶sub _createMemcachedConnection {
Subroutine _createMemcachedConnection: not called CC=1 SCAR=6.9
130 0 my ( $class, $secureTokenMemcachedServers ) = @_;
131  
132 # Open memcached connexion
133 0 my $memd = new Cache::Memcached {
134 'servers' => $secureTokenMemcachedServers,
135 'debug' => 0,
136 };
137  
138 0 $class->logger->debug("Memcached connection created");
139  
140 0 return $memd;
141 }
142  
143 ## @method private string _setToken(string value, int secureTokenExpiration)
144 # Set token value
145 # @param value Value
146 # @param secureTokenExpiration expiration
147 # @return Token key
148 0 ▶sub _setToken {
Subroutine _setToken: not called CC=2 SCAR=17.9
149 0 my ( $class, $value, $secureTokenExpiration ) = @_;
150 0 my $key = Apache::Session::Generate::MD5::generate();
151 0 my $res =
152 $secureTokenMemcachedConnection->set( $key, $value,
153 $secureTokenExpiration );
154  
155 0 ▶ unless ($res) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($res) 0 0 0
156 0 $class->logger->error("Unable to store secure token $key");
157 0 return;
158 }
159  
160 0 $class->logger->info("Set $value in token $key");
161  
162 0 return $key;
163 }
164  
165 ## @method private boolean _deleteToken(string key)
166 # Delete token
167 # @param key Key
168 # @return result
169 0 ▶sub _deleteToken {
Subroutine _deleteToken: not called CC=2 SCAR=17.9
170 0 my ( $class, $key ) = @_;
171 0 my $res = $secureTokenMemcachedConnection->delete($key);
172  
173 0 ▶ if ($res) {
Branch: 1 branch
BranchTrueFalseTotal
if ($res) { } 0 0 0
174 0 $class->logger->info("Token $key deleted");
175 }
176 else {
177 0 $class->logger->error("Unable to delete secure token $key");
178 }
179  
180 0 return $res;
181 }
182  
183 ## @method private boolean _isAlive()
184 # Run a STATS command to see if Memcached connection is alive
185 # @param connection Cache::Memcached object
186 # @return result
187 0 ▶sub _isAlive {
Subroutine _isAlive: not called CC=4 SCAR=30.0
188 0 my ($class) = @_;
189 0 ▶ return 0 unless defined $secureTokenMemcachedConnection;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $Lemonldap::NG::Handler::Lib::SecureToken::secureTokenMemcachedConnection 0 0 0
190 0 my $stats = $secureTokenMemcachedConnection->stats();
191  
192 0 ▶ if ( $stats and defined $stats->{'total'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($stats and defined $stats->{"total"}) 0 0 0
Condition0%0/3
$stats and defined $stats->{"total"}
!ll&&!rl&&r
000
MC/DC0%0/2
$stats and defined $stats->{"total"}
$stats defined $stats->{"total"}
Truth table0%0/3
A and B
A= $statsB= defined $stats->{"total"}
ABresult
0X0
100
111
193 0 my $total_c = $stats->{'total'}->{'connection_structures'};
194 0 my $total_i = $stats->{'total'}->{'total_items'};
195 0 $class->logger->debug(
196 "Memcached connection is alive ($total_c connections / $total_i items)"
197 );
198  
199 0 return 1;
200 }
201  
202 0 $class->logger->error('Memcached connection is down');
203  
204 0 return 0;
205 }
206  
207 ## @method private int _returnError(boolean secureTokenAllowOnError)
208 # Give hand back to Apache
209 # @param secureTokenAllowOnError
210 # @return Apache2::Const value
211 0 ▶sub _returnError {
Subroutine _returnError: not called CC=3 SCAR=24.8
212 0 my ( $class, $r, $secureTokenAllowOnError ) = @_;
213  
214 0 ▶ if ($secureTokenAllowOnError) {
Branch: 1 branch
BranchTrueFalseTotal
if ($secureTokenAllowOnError) 0 0 0
215 0 $class->logger->debug("Allow request without secure token");
216 0 return $class->OK;
217 }
218  
219 # Redirect or Forbidden?
220 0 ▶ if ( $class->tsv->{useRedirectOnError} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($class->tsv->{'useRedirectOnError'}) { } 0 0 0
221 0 $class->logger->debug("Use redirect for error");
222 0 return $class->goToError( '/', 500 );
223 }
224  
225 else {
226 0 $class->logger->debug("Return error");
227 0 return $class->SERVER_ERROR;
228 }
229 }
230  
231 1 1;
↑ Summary Lemonldap/NG/SSOaaS/Apache/Client.pm »