blib/lib/Lemonldap/NG/Portal/Plugins/CheckDevOps.pm untested

filter: Statementstmt 0.0% 0 / 175 Branchbran 0.0% 0 / 68 Conditioncond 0.0% 0 / 21 MC/DCmcdc 0.0% 0 / 14 Subroutinesub 0.0% 0 / 11 Podpod 0.0% 0 / 4 totaltotal 0.0% 0 / 293 CC 35 SCAR 63.3
CC
35
Cov
0%
parse
870.0
_checkSessionAttrs
20.0
display
12.0
CRAP 563.8
1 package Lemonldap::NG::Portal::Plugins::CheckDevOps;
2  
3 use strict;
4 use Mouse;
5 use JSON qw(from_json);
6 use Lemonldap::NG::Common::UserAgent;
7 use Lemonldap::NG::Common::Util qw(isHiddenAttr);
8 use Lemonldap::NG::Portal::Main::Constants qw(
9 URIRE
10 PE_OK
11 PE_BADURL
12 PE_NOTOKEN
13 PE_TOKENEXPIRED
14 PE_FILENOTFOUND
15 PE_BAD_DEVOPS_FILE
16 PE_REGISTERFORMEMPTY
17 );
18  
19 our $VERSION = '2.23.0';
20  
21 extends qw(
22 Lemonldap::NG::Portal::Main::Plugin
23 Lemonldap::NG::Portal::Lib::_tokenRule
24 );
25  
26 # INITIALIZATION
27  
28 has ott => (
29 is => 'rw',
30 lazy => 1,
31 default => sub {
32 my $ott =
33 $_[0]->{p}->loadModule('Lemonldap::NG::Portal::Lib::OneTimeToken');
34 $ott->timeout( $_[0]->{conf}->{formTimeout} );
35 return $ott;
36 }
37 );
38  
39 has ua => (
40 is => 'rw',
41 lazy => 1,
42 builder => sub {
43 my $ua = Lemonldap::NG::Common::UserAgent->new( $_[0]->{conf} );
44 $ua->env_proxy();
45 return $ua;
46 }
47 );
48  
49 sub init {
50 my ($self) = @_;
51 $self->addAuthRoute( checkdevops => 'parse', ['POST'] )
52 ->addAuthRouteWithRedirect( checkdevops => 'display', ['GET'] );
53  
54 unless ( $self->conf->{useSafeJail} ) {
55 $self->logger->warn('"CheckDevOps" plugin enabled WITHOUT SafeJail');
56 return 0;
57 }
58  
59 return 1;
60 }
61  
62 # RUNNING METHOD
63  
64 sub display {
65 my ( $self, $req ) = @_;
66  
67 # Display form
68 my $params = {
69 FORM_ACTION => $self->p->relativeUrl( $req, 'checkdevops' ),
70 DOWNLOAD => $self->conf->{checkDevOpsDownload},
71 MSG => 'checkDevOps',
72 ALERTE => 'alert-info',
73 TOKEN => (
74 $self->ottRule->( $req, {} )
75 ? $self->ott->createToken()
76 : ''
77 )
78 };
79 return $self->sendJSONresponse( $req, $params ) if $req->wantJSON;
80  
81 # Display form
82 return $self->p->sendHtml( $req, 'checkdevops', params => $params, );
83 }
84  
85 sub parse {
86 my ( $self, $req ) = @_;
87 my ( $headers, $rules, $unknown ) = ( [], [], [] );
88 my ( $msg, $json, $url, $bad_json );
89 my $alert = 'alert-danger';
90  
91 # Check token
92 if ( $self->ottRule->( $req, {} ) ) {
93 my $token;
94 $msg = PE_OK;
95 if ( $token = $req->param('token') ) {
96 unless ( $self->ott->getToken($token) ) {
97 $self->userLogger->warn(
98 'CheckDevOps called with an expired/bad token');
99 $msg = PE_TOKENEXPIRED;
100 $token = $self->ott->createToken();
101 }
102 }
103 else {
104 $self->userLogger->warn('CheckDevOps called without token');
105 $msg = PE_NOTOKEN;
106 $token = $self->ott->createToken();
107 }
108  
109 # Prepare form
110 my $params = {
111 FORM_ACTION => $self->p->relativeUrl( $req, 'checkdevops' ),
112 DOWNLOAD => $self->conf->{checkDevOpsDownload},
113 MSG => "PE$msg",
114 ALERTE => 'alert-warning',
115 TOKEN => $token
116 };
117 return $self->p->sendJSONresponse( $req, $params )
118 if ( $req->wantJSON && $msg );
119  
120 # Display form
121 return $self->p->sendHtml( $req, 'checkdevops', params => $params )
122 if $msg;
123 }
124  
125 $msg = 'PE' . PE_REGISTERFORMEMPTY
126 unless ( $req->param('url') || $req->param('checkDevOpsFile') );
127  
128 # Check URL if allowed and exists
129 if ( $self->conf->{checkDevOpsDownload} and $url = $req->param('url') ) {
130 undef $url if $self->p->checkXSSAttack( 'CheckDevOps URL', $url );
131 if ( $url && $url =~ URIRE ) {
132  
133 # Reformat url
134 my ( $proto, $vhost, $appuri ) = ( $2, $3, $5 );
135 $url = "$proto://$vhost/rules.json";
136 my $resp = $self->ua->get( $url, 'Accept' => 'application/json' );
137 $self->logger->debug( "Code/Message from $url: "
138 . $resp->code . '/'
139 . $resp->message );
140 my $content = $resp->decoded_content;
141 $self->logger->debug("Content received from $url: $content")
142 if $content;
143  
144 if ( $resp->is_success ) {
145 $json = eval { from_json( $content, { allow_nonref => 1 } ) };
146 if ($@) {
147  
148 # Prepare form params
149 undef $json;
150 $msg = 'PE' . PE_BAD_DEVOPS_FILE;
151 $self->userLogger->error(
152 "CheckDevOps: bad 'rules.json' file retrieved from $url ($@)"
153 );
154 }
155 }
156 else {
157  
158 # Prepare form params
159 $msg = 'PE' . PE_FILENOTFOUND;
160 $self->userLogger->error(
161 "CheckDevOps: Unable to download 'rules.json' file from $url"
162 );
163 }
164 }
165 else {
166  
167 # Prepare form params
168 $msg = 'PE' . PE_BADURL;
169 $self->userLogger->error('CheckDevOps: bad URL provided');
170 }
171 }
172 unless ( $json || $msg ) {
173 $json = eval {
174 from_json( $req->param('checkDevOpsFile'), { allow_nonref => 1 } );
175 } if $req->param('checkDevOpsFile');
176 if ( $@ || !$json->{rules} ) {
177  
178 # Prepare form params
179 undef $json;
180 $msg = 'PE' . PE_BAD_DEVOPS_FILE;
181 $alert = 'alert-danger';
182 $self->userLogger->error(
183 "CheckDevOps: bad provided 'rules.json' file ($@)");
184 }
185 }
186  
187 # Parse JSON
188 if ($json) {
189 my $handler = $self->p->HANDLER;
190 my $vhost = $handler->resolveAlias($req);
191  
192 # Removed hidden session attributes
193 foreach ( keys %{ $json->{headers} } ) {
194 my $header = $json->{headers}->{$_};
195 $header =~ s/^\$//;
196 if ( isHiddenAttr( $self->conf, $header ) ) {
197 my $user = $req->userData->{ $self->conf->{whatToTrace} };
198 $self->userLogger->warn(
199 "CheckDevOps: $user tried to retrieve a hidden attribute -> $header"
200 );
201 delete $json->{headers}->{$_};
202 }
203 }
204  
205 # Parse rules
206 my $cpt = new Safe;
207 $cpt->share_from( 'MIME::Base64', ['&encode_base64'] );
208 $cpt->share_from(
209 'Lemonldap::NG::Handler::Main::Jail',
210 [
211 '&encrypt', '&token',
212 @Lemonldap::NG::Handler::Main::Jail::builtCustomFunctions
213 ]
214 );
215 $cpt->share_from( 'Lemonldap::NG::Common::Safelib',
216 $Lemonldap::NG::Common::Safelib::functions );
217  
218 foreach ( keys %{ $json->{rules} } ) {
219 $cpt->reval( $json->{rules}->{$_} );
220 my $err = join(
221 '',
222 grep(
223 { $_ =~
224 /(?:Undefined subroutine|Devel::StackTrace|trapped by operation mask)/
225 ? ()
226 : $_; }
227 split( /\n/, $@, 0 ) )
228 );
229 if ($err) {
230 $self->userLogger->error(
231 "Bad rule: $json->{rules}->{$_} ($err)");
232 $bad_json = 1;
233 }
234 }
235  
236 # Compile headers
237 $handler->headersInit( undef, { $vhost => $json->{headers} } );
238 $headers = $handler->checkHeaders( $req, $req->userData );
239  
240 # Check attributes if required
241 if ( $self->conf->{checkDevOpsCheckSessionAttributes} ) {
242 $unknown = $self->_checkSessionAttrs($json);
243 $bad_json = 1 if scalar @$unknown;
244 }
245  
246 if ( $handler->tsv->{maintenance}->{$vhost} || $bad_json ) {
247  
248 # Prepare form params
249 undef $json;
250 $headers = [];
251 $alert = 'alert-danger';
252 $msg = 'PE' . PE_BAD_DEVOPS_FILE;
253 $self->userLogger->error("CheckDevOps: bad 'rules.json' file");
254 $handler->tsv->{maintenance}->{$vhost} = 0;
255 }
256 else {
257  
258 # Normalize headers name if required
259 if ( $self->conf->{checkDevOpsDisplayNormalizedHeaders} ) {
260 $self->logger->debug("Normalize headers...");
261 @$headers = map {
262 ; # Prevent compilation error with old Perl versions
263 no strict 'refs';
264 {
265 key => &{ $handler . '::cgiName' }( $_->{key} ),
266 value => $_->{value}
267 }
268 } @$headers;
269 }
270  
271 my $headers_list = join $self->conf->{multiValuesSeparator},
272 map "$_->{key}:$_->{value}",
273 @$headers;
274 $self->logger->debug("Compiled headers: $headers_list");
275  
276 # Compile rules
277 @$rules = map {
278 my ( $sub, $flag ) =
279 $handler->conditionSub( $json->{rules}->{$_} );
280 {
281 uri => $_,
282 access => $sub->( $req, $req->userData )
283 ? 'allowed'
284 : 'forbidden'
285 }
286 } sort keys %{ $json->{rules} };
287 my $rules_list = join $self->conf->{multiValuesSeparator},
288 map "$_->{uri}:$_->{access}", @$rules;
289 $self->logger->debug("Compiled rules: $rules_list");
290  
291 # Prepare form params
292 $msg = 'checkDevOps';
293 $alert = 'alert-info';
294 foreach ( keys %$json ) {
295 delete $json->{$_} unless $_ =~ /\b(?:rules|headers)\b/;
296 delete $json->{$_} unless keys %{ $json->{$_} };
297 }
298 $json = JSON->new->ascii->pretty->encode($json); # Pretty print
299 }
300 }
301  
302 # Prepare form
303 my $params = {
304 FORM_ACTION => $self->p->relativeUrl( $req, 'checkdevops' ),
305 DOWNLOAD => $self->conf->{checkDevOpsDownload},
306 MSG => $msg,
307 UNKNOWN => join( $self->conf->{multiValuesSeparator}, @$unknown ),
308 ALERTE => $alert,
309 FILE => $json,
310 HEADERS => $headers,
311 RULES => $rules,
312 URL => $url,
313 TOKEN => (
314 $self->ottRule->( $req, {} )
315 ? $self->ott->createToken()
316 : ''
317 )
318 };
319 return $self->p->sendJSONresponse( $req, $params ) if $req->wantJSON;
320  
321 # Display form
322 return $self->p->sendHtml( $req, 'checkdevops', params => $params );
323 }
324  
325 sub _checkSessionAttrs {
326 my ( $self, $json ) = @_;
327 my $unknown;
328 my %sessionAttrs = map { $_ => 1 } (
329 keys %{ $self->conf->{ldapExportedVars} },
330 keys %{ $self->conf->{exportedVars} },
331 keys %{ $self->conf->{macros} }
332 );
333 $sessionAttrs{groups} = 1 if $self->conf->{groups};
334 $self->logger->debug(
335 "Existing session attributes: "
336 . join $self->conf->{multiValuesSeparator},
337 keys %sessionAttrs
338 );
339  
340 my @varh = map { ( $json->{headers}->{$_} =~ /\$(\w+)\b/g ) }
341 keys %{ $json->{headers} };
342 my @varr = map { ( $json->{rules}->{$_} =~ /\$(\w+)\b/g ) }
343 keys %{ $json->{rules} };
344 my %usedAttrs = map { $_ => 1 } ( @varh, @varr );
345 $self->logger->debug(
346 "Used attributes: " . join $self->conf->{multiValuesSeparator},
347 keys %usedAttrs );
348  
349 @$unknown = map { $sessionAttrs{$_} ? () : $_ } sort keys %usedAttrs;
350 $self->logger->debug(
351 "Unknown attributes: " . join $self->conf->{multiValuesSeparator},
352 @$unknown )
353 if scalar @$unknown;
354  
355 return $unknown;
356 }
357  
358 1;