SAML.pm 98.2 KB
Newer Older
Yadd's avatar
Yadd committed
1 2 3 4 5 6
package Lemonldap::NG::Portal::Lib::SAML;

use strict;
use Mouse;
use Lemonldap::NG::Common::Conf::SAML::Metadata;
use Lemonldap::NG::Common::Session;
Yadd's avatar
Yadd committed
7
use Lemonldap::NG::Common::UserAgent;
Yadd's avatar
Yadd committed
8 9 10 11 12 13 14 15
use XML::Simple;
use MIME::Base64;
use String::Random;
use HTTP::Request;         # SOAP call
use POSIX qw(strftime);    # Convert SAML2 date into timestamp
use Time::Local;           # Convert SAML2 date into timestamp
use Encode;                # Encode attribute values
use URI;                   # Get metadata URL path
Yadd's avatar
Yadd committed
16 17 18 19 20
use Lemonldap::NG::Portal::Main::Constants qw(
  PE_OK
  PE_REDIRECT
  PE_SAML_SLO_ERROR
);
Yadd's avatar
Yadd committed
21 22 23 24 25

our $VERSION = '2.0.0';

# PROPERTIES

Yadd's avatar
Yadd committed
26 27 28
has lassoServer => ( is => 'rw' );
has spList      => ( is => 'rw', default => sub { {} } );
has idpList     => ( is => 'rw', default => sub { {} } );
Yadd's avatar
Yadd committed
29
has idpRules    => ( is => 'rw', default => sub { {} } );
Yadd's avatar
Yadd committed
30
has spRules     => ( is => 'rw', default => sub { {} } );
Yadd's avatar
Yadd committed
31

Yadd's avatar
Yadd committed
32 33 34
# return LWP::UserAgent object
has ua => (
    is      => 'rw',
Yadd's avatar
Yadd committed
35
    lazy    => 1,
Yadd's avatar
Yadd committed
36 37 38
    builder => sub {

        # TODO : LWP options to use a proxy for example
Yadd's avatar
Yadd committed
39
        my $ua = Lemonldap::NG::Common::UserAgent->new( $_[0]->{conf} );
Yadd's avatar
Yadd committed
40 41 42 43 44
        $ua->env_proxy();
        return $ua;
    }
);

Yadd's avatar
Yadd committed
45 46 47 48
# SAML storage
has aModule => ( is => 'rw' );
has amOpts  => ( is => 'rw' );

Yadd's avatar
Yadd committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
# INITIALIZATION

BEGIN {

    # Load Glib if available
    eval 'use Glib;';
    if ($@) {
        print STDERR
          "Glib Lasso messages will not be catched (require Glib module)\n";
        eval "use constant GLIB => 0";
    }
    else {
        eval "use constant GLIB => 1";
    }

    # Load Lasso.pm
    eval 'use Lasso;';
    if ($@) {
        print STDERR "Lasso.pm not loaded: $@";
        eval
'use constant LASSO => 0;use constant BADLASSO => 0;use constant LASSOTHINSESSIONS => 0';
    }
    else {
        no strict 'subs';
        eval 'use constant LASSO => 1';

        # Check Lasso version >= 2.3.0
        my $lasso_check_version_mode =
          eval 'Lasso::Constants::CHECK_VERSION_NUMERIC';
        my $check_version =
          Lasso::check_version( 2, 3, 0, $lasso_check_version_mode );
        unless ($check_version) {
            eval 'use constant BADLASSO => 1';
        }
        else {
            eval 'use constant BADLASSO => 0';
        }

        # Try to set thin-sessions flag
        eval 'Lasso::set_flag("thin-sessions");';
        if ($@) {
            eval 'use constant LASSOTHINSESSIONS => 0';
        }
        else {
            eval 'use constant LASSOTHINSESSIONS => 1';
        }
    }

}

sub init {
    my ($self) = @_;

Yadd's avatar
Yadd committed
102 103 104 105 106 107 108 109 110 111 112 113 114
    # Initialize SAML storage
    my $moduleOptions;
    if ( $self->conf->{samlStorage} ) {
        $moduleOptions = $self->conf->{samlStorageOptions} || {};
        $moduleOptions->{backend} = $self->conf->{samlStorage};
    }
    else {
        $moduleOptions = $self->conf->{globalStorageOptions} || {};
        $moduleOptions->{backend} = $self->conf->{globalStorage};
    }
    $self->aModule( $moduleOptions->{backend} );
    $self->amOpts($moduleOptions);

Yadd's avatar
Yadd committed
115 116 117 118 119 120 121 122 123 124 125 126
    # Check for Lasso errors/messages (see BEGIN)
    unless (LASSO) {
        $self->error("Module Lasso not loaded (see below)");
        return 0;
    }

    if (BADLASSO) {
        $self->error('Lasso version >= 2.3.0 required');
        return 0;
    }

    unless (LASSOTHINSESSIONS) {
Yadd's avatar
Yadd committed
127
        $self->logger->warn('Lasso thin-sessions flag could not be set');
Yadd's avatar
Yadd committed
128 129
    }
    else {
Yadd's avatar
Yadd committed
130
        $self->logger->debug('Lasso thin-sessions flag set');
Yadd's avatar
Yadd committed
131
    }
Yadd's avatar
Yadd committed
132 133 134 135 136
    if (GLIB) {
        Glib::Log->set_handler(
            "Lasso",
            [qw/ error critical warning message info debug /],
            sub {
Yadd's avatar
Yadd committed
137 138
                $self->logger->debug(
                    $_[0] . " error " . $_[1] . ": " . $_[2] );
Yadd's avatar
Yadd committed
139 140 141
            }
        );
    }
Yadd's avatar
Yadd committed
142 143 144

    # Conf initialization

Yadd's avatar
Yadd committed
145
    return 0 unless ( $self->lassoServer( $self->loadService ) );
Yadd's avatar
Yadd committed
146 147 148 149 150 151 152 153 154
    $self->addUnauthRoute(
        ( $self->{path} || 'saml' ) => { 'metadata' => 'metadata' },
        ['GET']
    );
    $self->addAuthRoute(
        ( $self->{path} || 'saml' ) => { 'metadata' => 'metadata' },
        ['GET']
    );
    return 1;
Yadd's avatar
Yadd committed
155
}
Yadd's avatar
Yadd committed
156

Yadd's avatar
Yadd committed
157 158
# METHODS

Yadd's avatar
Yadd committed
159 160 161 162
sub loadService {
    my ($self) = @_;

    # Check if certificate is available
Yadd's avatar
Yadd committed
163 164 165 166 167 168 169 170 171 172 173 174
    unless ($self->conf->{samlServicePublicKeySig}
        and $self->conf->{samlServicePrivateKeySig} )
    {
        $self->error('SAML private and public key not found in configuration');
        return 0;
    }

    my $serviceCertificate;
    if (    $self->conf->{samlServiceUseCertificateInResponse}
        and $self->conf->{samlServicePublicKeySig} =~ /CERTIFICATE/ )
    {
        $serviceCertificate = $self->conf->{samlServicePublicKeySig};
Yadd's avatar
Yadd committed
175
        $self->logger->debug('Certificate will be used in SAML responses');
Yadd's avatar
Yadd committed
176 177 178 179

    }

    # Get metadata from configuration
Yadd's avatar
Yadd committed
180
    $self->logger->debug("Get Metadata for this service");
Yadd's avatar
Yadd committed
181 182 183 184
    my $service_metadata = Lemonldap::NG::Common::Conf::SAML::Metadata->new();

    # Create Lasso server with service metadata
    my $server = $self->createServer(
Yadd's avatar
Yadd committed
185
        $service_metadata->serviceToXML( $self->conf ),
Yadd's avatar
Yadd committed
186 187
        $self->conf->{samlServicePrivateKeySig},
        $self->conf->{samlServicePrivateKeySigPwd},
Yadd's avatar
Yadd committed
188 189 190 191 192 193 194 195 196 197 198 199 200

        # use signature cert for encryption unless defined
        (
            $self->conf->{samlServicePrivateKeyEnc}
            ? (
                $self->conf->{samlServicePrivateKeyEnc},
                $self->conf->{samlServicePrivateKeyEncPwd}
              )
            : (
                $self->conf->{samlServicePrivateKeySig},
                $self->conf->{samlServicePrivateKeySigPwd}
            )
        ),
Yadd's avatar
Yadd committed
201 202 203
        $serviceCertificate
    );

204 205 206 207 208
    # Signature method
    my $method = $self->conf->{samlServiceSignatureMethod} || 'SHA1';
    $server->signature_method( $self->getSignatureMethod($method) );
    $self->logger->debug("Set $method as SAML server signature method ");

Yadd's avatar
Yadd committed
209 210 211 212 213
    # Log
    unless ($server) {
        $self->error('Unable to create Lasso server');
        return 0;
    }
Yadd's avatar
Yadd committed
214
    $self->logger->debug("Service created");
Yadd's avatar
Yadd committed
215 216 217 218

    return $server;
}

Yadd's avatar
Yadd committed
219 220 221 222 223 224 225
sub loadIDPs {
    my ($self) = @_;

    # Check presence of at least one identity provider in configuration
    unless ( $self->conf->{samlIDPMetaDataXML}
        and keys %{ $self->conf->{samlIDPMetaDataXML} } )
    {
226
        $self->logger->debug("No IDP found in configuration");
Yadd's avatar
Yadd committed
227 228 229 230 231 232 233 234 235 236 237
    }

    # Load identity provider metadata
    # IDP metadata are listed in $self->{samlIDPMetaDataXML}
    # Each key is the IDP name
    # Build IDP list for later use in extractFormInfo
    $self->idpList( {} );

    # TODO: QUESTION: do we have to return 0 (<=> block initialization) if one
    #                 IdP load fails ?
    foreach ( keys %{ $self->conf->{samlIDPMetaDataXML} } ) {
Yadd's avatar
Yadd committed
238
        $self->logger->debug("Get Metadata for IDP $_");
Yadd's avatar
Yadd committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263

        my $idp_metadata =
          $self->conf->{samlIDPMetaDataXML}->{$_}->{samlIDPMetaDataXML};

        # Check metadata format
        if ( ref $idp_metadata eq "HASH" ) {
            $self->error(
"Metadata for IDP $_ is in old format. Please reload them from Manager"
            );
            return 0;
        }

        if ( $self->conf->{samlMetadataForceUTF8} ) {
            $idp_metadata = encode( "utf8", $idp_metadata );
        }

        # Add this IDP to Lasso::Server
        my $result = $self->addIDP( $self->lassoServer, $idp_metadata );

        unless ($result) {
            $self->error("Fail to use IDP $_ Metadata");
            return 0;
        }

        # Store IDP entityID and Organization Name
Yadd's avatar
Yadd committed
264 265
        my ( $tmp, $entityID ) =
          ( $idp_metadata =~ /entityID=(['"])(.+?)\1/si );
Yadd's avatar
Yadd committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
        my $name = $self->getOrganizationName( $self->lassoServer, $entityID )
          || ucfirst($_);
        $self->idpList->{$entityID}->{confKey} = $_;
        $self->idpList->{$entityID}->{name}    = $name;

        # Set encryption mode
        my $encryption_mode = $self->conf->{samlIDPMetaDataOptions}->{$_}
          ->{samlIDPMetaDataOptionsEncryptionMode};
        my $lasso_encryption_mode = $self->getEncryptionMode($encryption_mode);

        unless (
            $self->setProviderEncryptionMode(
                $self->lassoServer->get_provider($entityID),
                $lasso_encryption_mode
            )
          )
        {
            $self->error(
                "Unable to set encryption mode $encryption_mode on IDP $_");
            return 0;
        }

Yadd's avatar
Yadd committed
288 289 290
        my $cond = $self->conf->{samlIDPMetaDataOptions}->{$_}
          ->{samlIDPMetaDataOptionsResolutionRule};
        if ( length $cond ) {
Yadd's avatar
Yadd committed
291
            $cond = $self->p->HANDLER->substitute($cond);
Yadd's avatar
Yadd committed
292
            unless ( $cond = $self->p->HANDLER->buildSub($cond) ) {
Yadd's avatar
Yadd committed
293
                $self->error( 'SAML IdP rule error: '
Yadd's avatar
Yadd committed
294
                      . $self->p->HANDLER->tsv->{jail}->error );
Yadd's avatar
Yadd committed
295 296 297 298
                return 0;
            }
            $self->idpRules->{$entityID} = $cond;
        }
Yadd's avatar
Yadd committed
299
        $self->logger->debug("Set encryption mode $encryption_mode on IDP $_");
Yadd's avatar
Yadd committed
300

Yadd's avatar
Yadd committed
301
        $self->logger->debug("IDP $_ added");
Yadd's avatar
Yadd committed
302 303 304 305 306 307 308 309 310 311 312
    }
    return 1;
}

sub loadSPs {
    my ($self) = @_;

    # Check presence of at least one service provider in configuration
    unless ( $self->conf->{samlSPMetaDataXML}
        and keys %{ $self->conf->{samlSPMetaDataXML} } )
    {
313
        $self->logger->debug("No SP found in configuration");
Yadd's avatar
Yadd committed
314 315 316 317 318 319 320 321 322
    }

    # Load service provider metadata
    # SP metadata are listed in $self->{samlSPMetaDataXML}
    # Each key is the SP name
    # Build SP list for later use in extractFormInfo
    $self->spList( {} );
    foreach ( keys %{ $self->conf->{samlSPMetaDataXML} } ) {

Yadd's avatar
Yadd committed
323
        $self->logger->debug("Get Metadata for SP $_");
Yadd's avatar
Yadd committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348

        my $sp_metadata =
          $self->conf->{samlSPMetaDataXML}->{$_}->{samlSPMetaDataXML};

        # Check metadata format
        if ( ref $sp_metadata eq "HASH" ) {
            $self->error(
"Metadata for SP $_ is in old format. Please reload them from Manager"
            );
            return 0;
        }

        if ( $self->conf->{samlMetadataForceUTF8} ) {
            $sp_metadata = encode( "utf8", $sp_metadata );
        }

        # Add this SP to Lasso::Server
        my $result = $self->addSP( $self->lassoServer, $sp_metadata );

        unless ($result) {
            $self->error("Fail to use SP $_ Metadata");
            return 0;
        }

        # Store SP entityID and Organization Name
Yadd's avatar
Yadd committed
349
        my ( $tmp, $entityID ) = ( $sp_metadata =~ /entityID=(['"])(.+?)\1/si );
Yadd's avatar
Yadd committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
        my $name = $self->getOrganizationName( $self->lassoServer, $entityID )
          || ucfirst($_);
        $self->spList->{$entityID}->{confKey} = $_;
        $self->spList->{$entityID}->{name}    = $name;

        # Set encryption mode
        my $encryption_mode = $self->conf->{samlSPMetaDataOptions}->{$_}
          ->{samlSPMetaDataOptionsEncryptionMode};
        my $lasso_encryption_mode = $self->getEncryptionMode($encryption_mode);

        unless (
            $self->setProviderEncryptionMode(
                $self->lassoServer->get_provider($entityID),
                $lasso_encryption_mode
            )
          )
        {
            $self->error(
                "Unable to set encryption mode $encryption_mode on SP $_");
            return 0;
        }

Yadd's avatar
Yadd committed
372 373 374 375 376 377 378 379 380 381 382 383
        my $rule = $self->conf->{samlSPMetaDataOptions}->{$_}
          ->{samlSPMetaDataOptionsRule};
        if ( length $rule ) {
            $rule = $self->p->HANDLER->substitute($rule);
            unless ( $rule = $self->p->HANDLER->buildSub($rule) ) {
                $self->error( 'SAML SP rule error: '
                      . $self->p->HANDLER->tsv->{jail}->error );
                return 0;
            }
            $self->spRules->{$entityID} = $rule;
        }

Yadd's avatar
Yadd committed
384
        $self->logger->debug("Set encryption mode $encryption_mode on SP $_");
Yadd's avatar
Yadd committed
385

Yadd's avatar
Yadd committed
386
        $self->logger->debug("SP $_ added");
Yadd's avatar
Yadd committed
387 388 389 390 391
    }

    return 1;
}

Yadd's avatar
Yadd committed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
# Check SAML requests and responses
sub checkMessage {
    my ( $self, $req, $url, $request_method, $content_type, $profile_type ) =
      @_;
    $profile_type ||= "login";

    # Create Profile object
    my $profile;
    $profile = $self->createLogin( $self->lassoServer )
      if ( $profile_type eq "login" );
    $profile = $self->createLogout( $self->lassoServer )
      if ( $profile_type eq "logout" );

    # Get relayState
    my $relaystate = $req->param('RelayState');
    my ( $method, $request, $response, $artifact, $message );

    # 2.1. HTTP REDIRECT
    if ( $request_method eq 'GET' ) {

        $method = Lasso::Constants::HTTP_METHOD_REDIRECT;
Yadd's avatar
Yadd committed
413
        $self->logger->debug("SAML method: HTTP-REDIRECT");
Yadd's avatar
Yadd committed
414 415 416 417 418

        if ( $req->param('SAMLResponse') ) {

            # Response in query string
            $response = $self->getQueryString($req);
Yadd's avatar
Yadd committed
419
            $self->logger->debug("HTTP-REDIRECT: SAML Response $response");
Yadd's avatar
Yadd committed
420 421 422 423 424 425 426

        }

        if ( $req->param('SAMLRequest') ) {

            # Request in query string
            $request = $self->getQueryString($req);
Yadd's avatar
Yadd committed
427
            $self->logger->debug("HTTP-REDIRECT: SAML Request $request");
Yadd's avatar
Yadd committed
428 429 430 431 432 433 434

        }

        if ( $req->param('SAMLart') ) {

            # Artifact in query string
            $artifact = $self->getQueryString($req);
Yadd's avatar
Yadd committed
435
            $self->logger->debug("HTTP-REDIRECT: SAML Artifact $artifact");
Yadd's avatar
Yadd committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458

            # Resolve Artifact
            $method = Lasso::Constants::HTTP_METHOD_ARTIFACT_GET;
            $message = $self->resolveArtifact( $profile, $artifact, $method );

            # Request or response ?
            if ( $message =~ /samlp:response/i ) {
                $response = $message;
            }
            else {
                $request = $message;
            }
        }

    }

    # 2.2. HTTP POST AND SOAP
    elsif ( $request_method =~ /^POST$/ ) {

        # 2.2.1. POST
        if ( $content_type !~ /xml/ ) {

            $method = Lasso::Constants::HTTP_METHOD_POST;
Yadd's avatar
Yadd committed
459
            $self->logger->debug("SAML method: HTTP-POST");
Yadd's avatar
Yadd committed
460 461 462 463 464

            if ( $req->param('SAMLResponse') ) {

                # Response in body part
                $response = $req->param('SAMLResponse');
Yadd's avatar
Yadd committed
465
                $response =~ s/ /+/g;
Yadd's avatar
Yadd committed
466
                $self->logger->debug("HTTP-POST: SAML Response $response");
Yadd's avatar
Yadd committed
467 468 469 470 471 472 473

            }

            elsif ( $req->param('SAMLRequest') ) {

                # Request in body part
                $request = $req->param('SAMLRequest');
Yadd's avatar
Yadd committed
474
                $self->logger->debug("HTTP-POST: SAML Request $request");
Yadd's avatar
Yadd committed
475 476 477 478 479 480 481

            }

            elsif ( $req->param('SAMLart') ) {

                # Artifact in SAMLart param
                $artifact = $req->param('SAMLart');
Yadd's avatar
Yadd committed
482
                $self->logger->debug("HTTP-POST: SAML Artifact $artifact");
Yadd's avatar
Yadd committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504

                # Resolve Artifact
                $method = Lasso::Constants::HTTP_METHOD_ARTIFACT_POST;
                $message =
                  $self->resolveArtifact( $profile, $artifact, $method );

                # Request or response ?
                if ( $message =~ /samlp:response/i ) {
                    $response = $message;
                }
                else {
                    $request = $message;
                }

            }

        }

        # 2.2.2. SOAP
        else {

            $method = Lasso::Constants::HTTP_METHOD_SOAP;
Yadd's avatar
Yadd committed
505
            $self->logger->debug("SAML method: HTTP-SOAP");
Yadd's avatar
Yadd committed
506 507

            # SOAP is always a request
508
            $request = $req->content;
Yadd's avatar
Yadd committed
509
            $self->logger->debug("HTTP-SOAP: SAML Request $request");
Yadd's avatar
Yadd committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

        }

    }

    # 4. Return values
    return ( $request, $response, $method, $relaystate, $artifact ? 1 : 0 );
}

## @method boolean checkLassoError(Lasso::Error error, string level)
# Log Lasso error code and message if this is actually a Lasso::Error with code > 0
# @param error Lasso error object
# @param level optional log level (debug by default)
# @return 1 if no error
sub checkLassoError {
    my ( $self, $error, $level ) = @_;
    $level ||= 'debug';

    # If $error is not a Lasso::Error object, display error string
    unless ( ref($error) and $error->isa("Lasso::Error") ) {
        return 1 unless $error;
Yadd's avatar
Yadd committed
531
        $self->p->lmLog( "Lasso error: $error", $level );
Yadd's avatar
Yadd committed
532 533 534 535 536
        return 0;
    }

    # Else check error code and error message
    if ( $error->{code} ) {
Yadd's avatar
Yadd committed
537
        $self->p->lmLog(
Yadd's avatar
Yadd committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
            "Lasso error code " . $error->{code} . ": " . $error->{message},
            $level );
        return 0;
    }

    return 1;
}

## @method Lasso::Server createServer(string metadata, string private_key, string private_key_password, string private_key_enc, string private_key_enc_password, string certificate)
# Load service metadata and create Lasso::Server object
# @param metadata SAML metadatas
# @param private_key private key
# @param private_key_password optional private key password
# @param private_key_enc optional private key for encryption
# @param private_key_enc_password optional private key password for encryption
# @param certificate optional certificate
# @return Lasso::Server object
sub createServer {
    my ( $self, $metadata, $private_key, $private_key_password,
        $private_key_enc, $private_key_enc_password, $certificate )
      = @_;
    my $server;

    eval {
        $server = Lasso::Server::new_from_buffers( $metadata, $private_key,
            $private_key_password, $certificate );

        # Set private key for encryption
        if ($private_key_enc) {
            Lasso::Server::set_encryption_private_key_with_password( $server,
                $private_key_enc, $private_key_enc_password );
        }
    };

    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    return $server;
}

## @method boolean addIDP(Lasso::Server server, string metadata, string public_key, string ca_cert_chain)
# Add IDP to an existing Lasso::Server
# @param server Lasso::Server object
# @param metadata IDP metadata
# @param public_key optional public key
# @param ca_cert_chain optional ca cert chain
# @return boolean result
sub addIDP {
    my ( $self, $server, $metadata, $public_key, $ca_cert_chain ) = @_;

    return 0 unless ( $server->isa("Lasso::Server") and defined $metadata );

    return $self->addProvider( $server, Lasso::Constants::PROVIDER_ROLE_IDP,
        $metadata, $public_key, $ca_cert_chain );
}

## @method boolean addSP(Lasso::Server server, string metadata, string public_key, string ca_cert_chain)
# Add SP to an existing Lasso::Server
# @param server Lasso::Server object
# @param metadata SP metadata
# @param public_key optional public key
# @param ca_cert_chain optional ca cert chain
# @return boolean result
sub addSP {
    my ( $self, $server, $metadata, $public_key, $ca_cert_chain ) = @_;

    return 0 unless ( $server->isa("Lasso::Server") and defined $metadata );

    return $self->addProvider( $server, Lasso::Constants::PROVIDER_ROLE_SP,
        $metadata, $public_key, $ca_cert_chain );
}

## @method boolean addAA(Lasso::Server server, string metadata, string public_key, string ca_cert_chain)
# Add Attribute Authority to an existing Lasso::Server
# @param server Lasso::Server object
# @param metadata AA metadata
# @param public_key optional public key
# @param ca_cert_chain optional ca cert chain
# @return boolean result
sub addAA {
    my ( $self, $server, $metadata, $public_key, $ca_cert_chain ) = @_;

    return 0 unless ( $server->isa("Lasso::Server") and defined $metadata );

    return $self->addProvider( $server,
        Lasso::Constants::PROVIDER_ROLE_ATTRIBUTE_AUTHORITY,
        $metadata, $public_key, $ca_cert_chain );
}

## @method boolean addProvider(Lasso::Server server, int role, string metadata, string public_key, string ca_cert_chain)
# Add provider to an existing Lasso::Server
# @param server Lasso::Server object
# @param role (IDP, SP or Both)
# @param metadata IDP metadata
# @param public_key optional public key
# @param ca_cert_chain optional ca cert chain
# @return boolean result
sub addProvider {
    my ( $self, $server, $role, $metadata, $public_key, $ca_cert_chain ) = @_;

    return 0
      unless ( $server->isa("Lasso::Server")
        and defined $role
        and defined $metadata );

    eval {
        Lasso::Server::add_provider_from_buffer( $server, $role, $metadata,
            $public_key, $ca_cert_chain );
    };

    return $self->checkLassoError($@);

}

## @method string getOrganizationName(Lasso::Server server, string idp)
# Return name of organization picked up from metadata
#@param server Lasso::Server object
#@param idp entity ID
#@return string organization name
sub getOrganizationName {
    my ( $self, $server, $idp ) = @_;
    my ( $provider, $node );

    # Get provider from server
    eval { $provider = Lasso::Server::get_provider( $server, $idp ); };

    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    # Get organization node
    eval { $node = Lasso::Provider::get_organization($provider); };

    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    # Return if node is empty
    return unless $node;

    # Extract organization name
    my $xs   = XML::Simple->new();
    my $data = $xs->XMLin($node);
    return $data->{OrganizationName}->{content};
}

## @method string getNextProviderId(Lasso::Logout logout)
# Returns the provider id from providerID_index in list of providerIDs in
# principal session with the exception of initial service provider ID.
# @param logout Lasso::Logout object
# @return string
sub getNextProviderId {
    my $self   = shift;
    my $logout = shift;
    my $providerId;

    eval { $providerId = Lasso::Logout::get_next_providerID($logout); };
    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    return $providerId;
}

## @method boolean resetProviderIdIndex(Lasso::Logout logout)
# Reset the providerID_index attribute in Lasso::Logout object
# @param logout Lasso::Logout object
# @return boolean
sub resetProviderIdIndex {
    my $self   = shift;
    my $logout = shift;

    eval { Lasso::Logout::reset_providerID_index($logout); };
    return $self->checkLassoError($@);
}

## @method Lasso::Login createAuthnRequest(Lasso::Server server, string idp, int method, boolean forceAuthn, boolean isPassive, string nameIDFormat, boolean allowProxiedAuthn, boolean signSSOMessage, string requestedAuthnContext)
# Create authentication request for selected IDP
# @param server Lasso::Server object
# @param idp IDP entityID
# @param method HTTP method
# @param forceAuthn force authentication on IDP
# @param isPassive require passive authentication
# @param nameIDFormat SAML2 NameIDFormat
# @param allowProxiedAuthn allow proxy on IDP
# @param signSSOMessage sign request
# @param requestedAuthnContext authentication context
# @return Lasso::Login object
sub createAuthnRequest {
    my (
        $self,           $req,          $server,
        $idp,            $method,       $forceAuthn,
        $isPassive,      $nameIDFormat, $allowProxiedAuthn,
        $signSSOMessage, $requestedAuthnContext
    ) = @_;
    my $proxyCount;
    my $proxyRequestedAuthnContext;

    # Create Lasso Login
    my $login = $self->createLogin($server);

    unless ($login) {
Yadd's avatar
Yadd committed
745
        $self->logger->error('Unable to create Lasso login');
Yadd's avatar
Yadd committed
746 747 748 749 750
        return;
    }

    # Init authentication request
    unless ( $self->initAuthnRequest( $login, $idp, $method ) ) {
Yadd's avatar
Yadd committed
751 752
        $self->logger->error(
            "Could not initiate authentication request on $idp");
Yadd's avatar
Yadd committed
753 754 755 756
        return;
    }

    # Set RelayState
Yadd's avatar
Yadd committed
757
    if ( my $relaystate = $self->storeRelayState( $req, 'urldc' ) ) {
Yadd's avatar
Yadd committed
758
        $login->msg_relayState($relaystate);
Yadd's avatar
Yadd committed
759
        $self->logger->debug("Set $relaystate in RelayState");
Yadd's avatar
Yadd committed
760 761 762 763 764 765 766 767 768 769 770
    }

    # Customize request
    my $request = $login->request();

    # Maybe we are in IDP proxy mode (SAML request received on IDP side)
    # In this case:
    # * Check proxy conditions
    # * Forward some authn constraints
    if ( $req->datas->{_proxiedSamlRequest} ) {

Yadd's avatar
Yadd committed
771
        $self->logger->debug("IDP Proxy mode detected");
Yadd's avatar
Yadd committed
772 773 774 775 776 777 778 779 780 781

        # Get ProxyCount value
        eval {
            $proxyCount =
              $req->datas->{_proxiedSamlRequest}->Scoping()->ProxyCount();
        };

        # Deny request if ProxyCount eq 0
        if ( defined $proxyCount ) {

Yadd's avatar
Yadd committed
782 783
            $self->logger->debug(
                "Found proxyCount $proxyCount in proxied request");
Yadd's avatar
Yadd committed
784 785

            if ( $proxyCount eq 0 ) {
Yadd's avatar
Yadd committed
786 787
                $self->userLogger->error(
                    "SAML request cannot be proxied (ProxyCount 0)");
Yadd's avatar
Yadd committed
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
                return;
            }
            else {

                # Decrease ProxyCount
                my $scoping = $req->datas->{_proxiedSamlRequest}->Scoping();
                $scoping->ProxyCount( $proxyCount-- );
                eval { $request->Scoping($scoping); };
            }
        }

        # isPassive
        eval { $isPassive = $req->datas->{_proxiedSamlRequest}->IsPassive(); };

        # forceAuthn
        eval { $forceAuthn = $req->datas->{_proxiedSamlRequest}->ForceAuthn(); };

        # requestedAuthnContext
        eval {
            $proxyRequestedAuthnContext =
              $req->datas->{_proxiedSamlRequest}->RequestedAuthnContext();
        };
    }

    # NameIDFormat
    if ($nameIDFormat) {
Yadd's avatar
Yadd committed
814
        $self->logger->debug("Use NameIDFormat $nameIDFormat");
Yadd's avatar
Yadd committed
815 816 817 818 819 820 821 822
        $request->NameIDPolicy()->Format($nameIDFormat);
    }

    # Always allow NameID creation
    $request->NameIDPolicy()->AllowCreate(1);

    # Force authentication
    if ($forceAuthn) {
Yadd's avatar
Yadd committed
823
        $self->logger->debug("Force authentication on IDP");
Yadd's avatar
Yadd committed
824 825 826 827 828
        $request->ForceAuthn(1);
    }

    # Passive authentication
    if ($isPassive) {
Yadd's avatar
Yadd committed
829
        $self->logger->debug("Passive authentication on IDP");
Yadd's avatar
Yadd committed
830 831 832 833 834
        $request->IsPassive(1);
    }

    # Allow proxy
    unless ($allowProxiedAuthn) {
Yadd's avatar
Yadd committed
835
        $self->logger->debug("Do not allow this request to be proxied");
Yadd's avatar
Yadd committed
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
        eval {
            my $proxyRestriction = Lasso::Saml2ProxyRestriction->new();
            $proxyRestriction->Audience($idp);
            $proxyRestriction->Count(0);
            my $conditions = $request->Conditions()
              || Lasso::Saml2Conditions->new();
            $conditions->ProxyRestriction($proxyRestriction);
            $request->Conditions($conditions);
        };
        if ($@) {
            $self->checkLassoError($@);
            return;
        }
    }

    # Signature
    if ( $signSSOMessage == 0 ) {
Yadd's avatar
Yadd committed
853
        $self->logger->debug("SSO request will not be signed");
Yadd's avatar
Yadd committed
854 855 856
        $self->disableSignature($login);
    }
    elsif ( $signSSOMessage == 1 ) {
Yadd's avatar
Yadd committed
857
        $self->logger->debug("SSO request will be signed");
Yadd's avatar
Yadd committed
858 859 860
        $self->forceSignature($login);
    }
    else {
Yadd's avatar
Yadd committed
861
        $self->logger->debug("SSO request signature according to metadata");
Yadd's avatar
Yadd committed
862 863 864 865
    }

    # Requested authentication context
    if ($proxyRequestedAuthnContext) {
Yadd's avatar
Yadd committed
866
        $self->logger->debug("Use RequestedAuthnContext from proxied request");
Yadd's avatar
Yadd committed
867 868 869
        $request->RequestedAuthnContext($proxyRequestedAuthnContext);
    }
    elsif ($requestedAuthnContext) {
Yadd's avatar
Yadd committed
870
        $self->logger->debug("Request $requestedAuthnContext context");
Yadd's avatar
Yadd committed
871 872 873 874 875 876 877 878 879 880 881 882 883 884
        eval {
            my $context = Lasso::Samlp2RequestedAuthnContext->new();
            $context->AuthnContextClassRef($requestedAuthnContext);
            $context->Comparison("minimum");
            $request->RequestedAuthnContext($context);
        };
        if ($@) {
            $self->checkLassoError($@);
            return;
        }
    }

    # Build authentication request
    unless ( $self->buildAuthnRequestMsg($login) ) {
Yadd's avatar
Yadd committed
885
        $self->logger->error("Could not build authentication request on $idp");
Yadd's avatar
Yadd committed
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
        return;
    }

    # Artifact
    if (   $method == $self->getHttpMethod("artifact-get")
        or $method == $self->getHttpMethod("artifact-post") )
    {

        # Get artifact ID and Content, and store them
        my $artifact_id      = $login->get_artifact;
        my $artifact_message = $login->get_artifact_message;

        $self->storeArtifact( $artifact_id, $artifact_message );
    }
    return $login;
}

## @method Lasso::Login createLogin(Lasso::Server server, string dump)
# Create Lasso::Login object
# @param server Lasso::Server object
# @param dump optional XML dump
# @return Lasso::Login object
sub createLogin {
    my ( $self, $server, $dump ) = @_;
    my $login;

    if ($dump) {
        eval { $login = Lasso::Login::new_from_dump( $server, $dump ); };
    }
    else {
        eval { $login = Lasso::Login->new($server); };
    }

    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    return $login;
}

## @method boolean initAuthnRequest(Lasso::Login login, string idp, int method)
# Init authentication request
# @param login Lasso::Login
# @param idp entityID
# @param method HTTP method
# @return boolean result
sub initAuthnRequest {
    my ( $self, $login, $idp, $method ) = @_;

    eval { Lasso::Login::init_authn_request( $login, $idp, $method ); };

    return $self->checkLassoError($@);
}

## @method boolean initIdpInitiatedAuthnRequest(Lasso::Login login, string idp)
# Init authentication request
# @param login Lasso::Login
# @param idp entityID
# @return boolean result
sub initIdpInitiatedAuthnRequest {
    my ( $self, $login, $idp ) = @_;

    eval { Lasso::Login::init_idp_initiated_authn_request( $login, $idp ); };

    return $self->checkLassoError($@);
}

## @method boolean buildAuthnRequestMsg(Lasso::Login login)
# Build authentication request message
# @param login Lasso::Login
# @return boolean result
sub buildAuthnRequestMsg {
    my ( $self, $login ) = @_;

    eval { Lasso::Login::build_authn_request_msg($login); };

    return $self->checkLassoError($@);
}

## @method boolean processAuthnRequestMsg(Lasso::Login login, string request)
# Process authentication request message
# @param login Lasso::Login object
# @param request SAML request
# @return result
sub processAuthnRequestMsg {
    my ( $self, $login, $request ) = @_;

    eval { Lasso::Login::process_authn_request_msg( $login, $request ); };

    return $self->checkLassoError($@);
}

## @method boolean validateRequestMsg(Lasso::Login login, boolean auth, boolean consent)
# Validate request message
# @param login Lasso::Login object
# @param auth is user authenticated?
# @param consent is consent obtained?
# @return result
sub validateRequestMsg {
    my ( $self, $login, $auth, $consent ) = @_;

    eval { Lasso::Login::validate_request_msg( $login, $auth, $consent ); };

    return $self->checkLassoError($@);
}

## @method boolean buildAuthnResponseMsg(Lasso::Login login)
# Build authentication response message
# @param login Lasso::Login object
# @return boolean result
sub buildAuthnResponseMsg {
    my ( $self, $login ) = @_;

    eval { Lasso::Login::build_authn_response_msg($login); };

    return $self->checkLassoError($@);
}

## @method boolean buildArtifactMsg(Lasso::Login login, int method)
# Build artifact message
# @param login Lasso::Login object
# @param method HTTP method
# @return boolean result
sub buildArtifactMsg {
    my ( $self, $login, $method ) = @_;

    eval { Lasso::Login::build_artifact_msg( $login, $method ); };

    return $self->checkLassoError($@);
}

## @method boolean buildAssertion(Lasso::Login login, string authn_context, int notOnOrAfterTimeout)
# Build assertion
# @param login Lasso::Login object
# @param authn_context SAML2 authentication context
# @param notOnOrAfterTimeout Timeout to apply to notOnOrAfter
# @return boolean result
sub buildAssertion {
    my ( $self, $req, $login, $authn_context, $notOnOrAfterTimeout ) = @_;
    $notOnOrAfterTimeout ||= $self->conf->{timeout};

    # Dates
    my $time                    = $req->sessionInfo->{_utime} || time();
    my $timeout                 = $time + $notOnOrAfterTimeout;
    my $authenticationInstant   = $self->timestamp2samldate($time);
    my $reauthenticateOnOrAfter = $self->timestamp2samldate($timeout);
    my $issued_time             = time;
    my $notBefore               = $self->timestamp2samldate($issued_time);
    my $notOnOrAfter =
      $self->timestamp2samldate( $issued_time + $notOnOrAfterTimeout );

    eval {
        Lasso::Login::build_assertion( $login, $authn_context,
            $authenticationInstant, $reauthenticateOnOrAfter, $notBefore,
            $notOnOrAfter );
    };

    return $self->checkLassoError($@);
}

## @method boolean processAuthnResponseMsg(Lasso::Login login, string response)
# Process authentication response message
# @param login Lasso::Login object
# @param response SAML response
# @return result
sub processAuthnResponseMsg {
    my ( $self, $login, $response ) = @_;

    eval { Lasso::Login::process_authn_response_msg( $login, $response ); };

    return $self->checkLassoError($@);
}

Yadd's avatar
Yadd committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
# UNUSED
### @method Lasso::Saml2NameID getNameIdentifer(Lasso::Profile profile)
## Get NameID from Lasso Profile
## @param profile Lasso::Profile object
## @return result or NULL if error
#sub getNameIdentifier {
#    my ( $self, $profile ) = @_;
#    my $nameid;
#
#    eval { $nameid = Lasso::Profile::get_nameIdentifier($profile); };
#
#    if ($@) {
#        $self->checkLassoError($@);
#        return;
#    }
#
#    return $nameid;
#}

# UNUSED
### @method Lasso::Identity createIdentity(string dump)
## Create Lasso::Identity object
## @param dump optional Identity dump
## @return Lasso::Identity object
#sub createIdentity {
#    my ( $self, $dump ) = @_;
#    my $identity;
#
#    if ($dump) {
#        eval { $identity = Lasso::Identity::new_from_dump($dump); };
#    }
#    else {
#        eval { $identity = Lasso::Identity->new(); };
#    }
#
#    if ($@) {
#        $self->checkLassoError($@);
#        return;
#    }
#
#    return $identity;
#}

## UNUSED
### @method Lasso::Session createSession(string dump)
## Create Lasso::Session object
## @param dump optional Session dump
## @return Lasso::Session object
#sub createSession {
#    my ( $self, $dump ) = @_;
#    my $session;
#
#    if ($dump) {
#        eval { $session = Lasso::Session::new_from_dump($dump); };
#    }
#    else {
#        eval { $session = Lasso::Session->new(); };
#    }
#
#    if ($@) {
#        $self->checkLassoError($@);
#        return;
#    }
#
#    return $session;
#}
Yadd's avatar
Yadd committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

## @method boolean acceptSSO(Lasso::Login login)
# Accept SSO from IDP
# @param login Lasso::Login object
# @return result
sub acceptSSO {
    my ( $self, $login ) = @_;

    eval { Lasso::Login::accept_sso($login); };

    return $self->checkLassoError($@);
}

## @method string storeRelayState(hashref infos)
# Store information in relayState database and return
# corresponding session_id
# @param infos HASH reference of information
sub storeRelayState {
    my ( $self, $req, @data ) = @_;

    # check if there are data to store
    my $infos;
    foreach (@data) {
        $infos->{$_} = $req->{$_} if $req->{$_};
    }
    return unless ($infos);

    # Session type
    $infos->{_type} = "relaystate";

    # Set _utime for session autoremove
    # Use default session timeout and relayState session timeout to compute it
    my $time    = time();
    my $timeout = $self->conf->{timeout};
    my $samlRelayStateTimeout =
      $self->conf->{samlRelayStateTimeout} || $timeout;

    $infos->{_utime} = $time + ( $samlRelayStateTimeout - $timeout );

1165 1166 1167
    # Create relaystate session and store infos in relaystate session
    my $samlSessionInfo = $self->getSamlSession( undef, $infos )
      or return undef;
Yadd's avatar
Yadd committed
1168 1169 1170 1171 1172 1173 1174 1175

    # Session ID
    my $relaystate_id = $samlSessionInfo->id;

    # Return session ID
    return $relaystate_id;
}

1176
## @method boolean extractRelayState(string relaystate, boolean relayStateURL)
Yadd's avatar
Yadd committed
1177 1178
# Extract RelayState information into $self
# @param relaystate Relay state value
1179
# @param relayStateURL Allow Relay state value to be the redirection URL
Yadd's avatar
Yadd committed
1180 1181
# @return result
sub extractRelayState {
1182
    my ( $self, $req, $relaystate, $relayStateURL ) = @_;
Yadd's avatar
Yadd committed
1183 1184

    return 0 unless $relaystate;
1185
    if ( $relayStateURL and $relaystate =~ /^https?:\/\// ) {
Yadd's avatar
Yadd committed
1186
        $self->logger->debug("RelayState is a redirection URL: $relaystate");
1187 1188 1189 1190
        $req->{urldc} = $relaystate;
        return 1;
    }
    else {
Yadd's avatar
Yadd committed
1191

1192 1193
        # Open relaystate session
        my $samlSessionInfo = $self->getSamlSession($relaystate);
Yadd's avatar
Yadd committed
1194

1195
        return 0 unless $samlSessionInfo;
Yadd's avatar
Yadd committed
1196

1197 1198 1199
        # Push values in $self
        foreach ( keys %{ $samlSessionInfo->data } ) {
            next if $_ =~ /(type|_session_id|_utime)/;
Yadd's avatar
Yadd committed
1200 1201
            if ( $_ eq 'issuerUrldc' ) {
                $req->urldc( $samlSessionInfo->data->{$_} );
1202 1203 1204 1205
            }
            else {
                $req->{$_} = $samlSessionInfo->data->{$_};
            }
1206 1207 1208 1209
        }

        # delete relaystate session
        if ( $samlSessionInfo->remove ) {
Yadd's avatar
Yadd committed
1210
            $self->logger->debug("Relaystate $relaystate was deleted");
1211 1212
        }
        else {
Yadd's avatar
Yadd committed
1213 1214
            $self->logger->error("Unable to delete relaystate $relaystate");
            $self->logger->error( $samlSessionInfo->error );
1215
        }
Yadd's avatar
Yadd committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276

    }

    return 1;
}

## @method Lasso::Node getAssertion(Lasso::Login login)
# Get assertion in Lasso::Login object
# @param login Lasso::Login object
# @return assertion Lasso::Node object
sub getAssertion {
    my ( $self, $login ) = @_;
    my $assertion;

    eval { $assertion = Lasso::Login::get_assertion($login); };

    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    return $assertion;
}

## @method string getAttributeValue(string name, string format, string friendly_name, arrayref attributes, boolean force_utf8)
# Get SAML attribute value corresponding to name, format and friendly_name
# Multivaluated values are separated by multiValuesSeparator
# If force_utf8 flag is set, value is encoded in UTF-8
# @param name SAML attribute name
# @param format optional SAML attribute format
# @param friendly_name optional SAML attribute friendly name
# @param attributes Attributes
# @param force_utf8 optional flag to force value in UTF-8
# @return attribute value
sub getAttributeValue {
    my ( $self, $name, $format, $friendly_name, $attributes, $force_utf8 ) = @_;
    my $value;

    # Loop on attributes
    foreach (@$attributes) {
        my $attr_name   = $_->Name();
        my $attr_format = $_->NameFormat();
        my $attr_fname  = $_->FriendlyName();

        # Skip if name does not correspond to attribute name
        next if ( $name ne $attr_name );

        # Verify format and friendly name if given
        next if ( $format        and $format ne $attr_format );
        next if ( $friendly_name and $friendly_name ne $attr_fname );

        # Attribute is found, return its content
        my @attr_values = $_->AttributeValue();

        foreach (@attr_values) {
            my $xs      = XML::Simple->new();
            my $data    = $xs->XMLin( $_->dump() );
            my $content = $data->{content};
            $value .= $content . $self->conf->{multiValuesSeparator}
              if $content;
        }
Yadd's avatar
Yadd committed
1277
        $value =~ s/$self->{conf}->{multiValuesSeparator}$//;
Yadd's avatar
Yadd committed
1278 1279 1280 1281 1282 1283 1284 1285 1286

        # Encode UTF-8 if force_utf8 flag
        $value = encode( "utf8", $value ) if $force_utf8;

    }

    return $value;
}

1287
## @method boolean validateConditions(Lasso::Saml2::Assertion assertion, string entityID, boolean checkTime, boolean checkAudience)
Yadd's avatar
Yadd committed
1288 1289 1290
# Validate conditions
# @param assertion SAML2 assertion
# @param entityID relying party entity ID
1291 1292
# @param checkTime Enable time conditions check
# @param checkAudience Enable audience conditions check
Yadd's avatar
Yadd committed
1293 1294
# @return result
sub validateConditions {
1295
    my ( $self, $assertion, $entityID, $checkTime, $checkAudience ) = @_;
Yadd's avatar
Yadd committed
1296 1297
    my $tolerance = 10;
    my $status;
1298 1299
    $checkTime     = 1 unless defined $checkTime;
    $checkAudience = 1 unless defined $checkAudience;
Yadd's avatar
Yadd committed
1300 1301

    # Time
1302 1303
    if ($checkTime) {
        eval {
Yadd's avatar
Yadd committed
1304
            $status = Lasso::Saml2Assertion::validate_time_checks( $assertion,
1305 1306
                $tolerance );
        };
Yadd's avatar
Yadd committed
1307

1308 1309 1310 1311
        if ($@) {
            $self->checkLassoError($@);
            return 0;
        }
Yadd's avatar
Yadd committed
1312

1313
        unless ( $status eq Lasso::Constants::SAML2_ASSERTION_VALID ) {
Yadd's avatar
Yadd committed
1314
            $self->logger->error("Time conditions validations result: $status");
1315 1316
            return 0;
        }
Yadd's avatar
Yadd committed
1317

Yadd's avatar
Yadd committed
1318
        $self->logger->debug("Time conditions validated");
1319 1320
    }
    else {
Yadd's avatar
Yadd committed
1321
        $self->logger->debug("Time conditions not checked");
1322
    }
Yadd's avatar
Yadd committed
1323 1324

    # Audience
1325 1326 1327 1328 1329
    if ($checkAudience) {
        eval {
            $status =
              Lasso::Saml2Assertion::validate_audience( $assertion, $entityID );
        };
Yadd's avatar
Yadd committed
1330

1331 1332 1333 1334
        if ($@) {
            $self->checkLassoError($@);
            return 0;
        }
Yadd's avatar
Yadd committed
1335

1336
        unless ( $status eq Lasso::Constants::SAML2_ASSERTION_VALID ) {
Yadd's avatar
Yadd committed
1337 1338
            $self->logger->error(
                "Audience conditions validations result: $status");
1339 1340
            return 0;
        }
Yadd's avatar
Yadd committed
1341

Yadd's avatar
Yadd committed
1342
        $self->logger->debug("Audience conditions validated");
1343 1344
    }
    else {
Yadd's avatar
Yadd committed
1345
        $self->logger->debug("Audience conditions not checked");
1346
    }
Yadd's avatar
Yadd committed
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365

    return 1;
}

## @method Lasso::Logout createLogoutRequest(Lasso::Server server, string session_dump, int method, boolean signSLOMessage)
# Create logout request for selected entity
# @param server Lasso::Server object
# @param session_dump Lasso::Session dump
# @param method HTTP method
# @param signSLOMessage sign request
# @return Lasso::Login object
sub createLogoutRequest {
    my ( $self, $req, $server, $session_dump, $method, $signSLOMessage ) = @_;
    my $session;

    # Create Lasso Logout
    my $logout = $self->createLogout($server);

    unless ( $self->setSessionFromDump( $logout, $session_dump ) ) {
Yadd's avatar
Yadd committed
1366
        $self->logger->error("Could not fill Lasso::Logout with session dump");
Yadd's avatar
Yadd committed
1367 1368 1369 1370 1371
        return;
    }

    # Init logout request
    unless ( $self->initLogoutRequest( $logout, undef, $method ) ) {
Yadd's avatar
Yadd committed
1372
        $self->logger->error("Could not initiate logout request");
Yadd's avatar
Yadd committed
1373 1374 1375 1376 1377 1378
        return;
    }

    # Set RelayState
    if ( my $relaystate = $self->storeRelayState( $req, 'urldc' ) ) {
        $logout->msg_relayState($relaystate);
Yadd's avatar
Yadd committed
1379
        $self->logger->debug("Set $relaystate in RelayState");
Yadd's avatar
Yadd committed
1380 1381 1382 1383
    }

    # Signature
    if ( $signSLOMessage == 0 ) {
Yadd's avatar
Yadd committed
1384
        $self->logger->debug("SLO request will not be signed");
Yadd's avatar
Yadd committed
1385 1386 1387
        $self->disableSignature($logout);
    }
    elsif ( $signSLOMessage == 1 ) {
Yadd's avatar
Yadd committed
1388
        $self->logger->debug("SLO request will be signed");
Yadd's avatar
Yadd committed
1389 1390 1391
        $self->forceSignature($logout);
    }
    else {
Yadd's avatar
Yadd committed
1392
        $self->logger->debug("SLO request signature according to metadata");
Yadd's avatar
Yadd committed
1393 1394 1395 1396
    }

    # Build logout request
    unless ( $self->buildLogoutRequestMsg($logout) ) {
Yadd's avatar
Yadd committed
1397
        $self->logger->error("Could not build logout request");
Yadd's avatar
Yadd committed
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
        return;
    }

    return $logout;

}

## @method Lasso::Logout createLogout(Lasso::Server server, string dump)
# Create Lasso::Logout object
# @param server Lasso::Server object
# @param dump optional XML dump
# @return Lasso::Logout object
sub createLogout {
    my ( $self, $server, $dump ) = @_;
    my $logout;

    if ($dump) {
        eval { $logout = Lasso::Logout::new_from_dump( $server, $dump ); };
    }
    else {
        eval { $logout = Lasso::Logout->new($server); };
    }

    if ($@) {
        $self->checkLassoError($@);
        return;
    }

    return $logout;
}

## @method boolean initLogoutRequest(Lasso::Logout logout, string entityID, int method)
# Init logout request
# @param logout Lasso::Logout object
# @param entityID Entity ID
# @param method HTTP method
# @return result
sub initLogoutRequest {
    my ( $self, $logout, $entityID, $method ) = @_;

    eval { Lasso::Logout::init_request( $logout, $entityID, $method ); };

    return $self->checkLassoError($@);
}

## @method boolean buildLogoutRequestMsg(Lasso::Logout logout)
# Build logout request message
# @param logout Lasso::Logout object
# @return result
sub buildLogoutRequestMsg {
    my ( $self, $logout ) = @_;

    eval { Lasso::Logout::build_request_msg($logout); };

    return $self->checkLassoError($@);
}

## @method boolean setSessionFromDump(Lasso::Profile profile, string dump)
# Set session from dump in Lasso::Profile object
# @param profile Lasso::Profile object
# @param dump Lasso::Session XML dump
# @return result
sub setSessionFromDump {
    my ( $self, $profile, $dump ) = @_;

Yadd's avatar
Yadd committed
1463
    $self->logger->debug("Loading Session dump: $dump");
Yadd's avatar
Yadd committed
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490

    eval { Lasso::Profile::set_session_from_dump( $profile, $dump ); };

    return $self->checkLassoError($@);
}

## @method boolean setIdentityFromDump(Lasso::Profile profile, string dump)
# Set identity from dump in Lasso::Profile object
# @param profile Lasso::Profile object
# @param dump Lasso::Identity XML dump
# @return result
sub setIdentityFromDump {
    my ( $self, $profile, $dump ) = @_;

    eval { Lasso::Profile::set_identity_from_dump( $profile, $dump ); };

    return $self->checkLassoError($@);
}

## @method string getMetaDataURL(string key, int index)
# Get URL stored in a service metadata configuration key
# Replace #PORTAL# macro
# @param key Metadata configuration key
# @param index field index containing URL
# @param full Return full URL instead of path
# @return url
sub getMetaDataURL {
Yadd's avatar
Yadd committed
1491
    my ( $self, $key, $index, $full ) = @_;
Yadd's avatar
Yadd committed
1492 1493 1494
    $index = 3 unless defined $index;
    $full  = 0 unless defined $full;

Yadd's avatar
Yadd committed
1495
    return '' unless defined $self->conf->{$key};
Yadd's avatar
Yadd committed
1496

Yadd's avatar
Yadd committed
1497
    my $url = ( split( /;/, $self->conf->{$key} ) )[$index] || '';
Yadd's avatar
Yadd committed
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513

    # Get portal value
    my $portal = $self->conf->{portal};
    $portal =~ s/\/$//;

    # Replace #PORTAL# macro
    $url =~ s/#PORTAL#/$portal/g;

    # Return Full URL
    return $url if $full;

    # Return only path
    my $uri = URI->new($url);
    return $uri->path();
}

1514 1515 1516 1517
sub getRouteFromMetaDataURL {
    my ( $self, $key, $index, $sub ) = @_;
    my $uri = $self->getMetaDataURL( $key, $index, 0 );
    unless ( $uri =~ m#^/\w# ) {
Yadd's avatar
Yadd committed
1518
        $self->logger->debug("$key has no index $index");
Yadd's avatar
Yadd committed
1519
        return ();
1520 1521 1522 1523 1524 1525 1526 1527 1528
    }
    my @t = grep /\w/, split( /\//, $uri );
    my $h = { pop(@t) => $sub };
    while ( my $s = pop @t ) {
        $h = { $s => $h };
    }
    return %$h;
}

Yadd's avatar
Yadd committed
1529
sub addRouteFromMetaDataURL {
1530
    my ( $self, @args ) = @_;
Yadd's avatar
Yadd committed
1531 1532
    $self->addAuthRouteFromMetaDataURL(@args);
    $self->addUnauthRouteFromMetaDataURL(@args);
1533 1534
}

Yadd's avatar
Yadd committed
1535
sub addAuthRouteFromMetaDataURL {
1536 1537 1538 1539 1540 1541
    my ( $self, $key, $index, $sub, $methods ) = @_;
    my %route = $self->getRouteFromMetaDataURL( $key, $index, $sub );
    return unless (%route);
    $self->addAuthRoute( %route, $methods );
}

Yadd's avatar
Yadd committed
1542
sub addUnauthRouteFromMetaDataURL {
1543 1544 1545 1546 1547 1548
    my ( $self, $key, $index, $sub, $methods ) = @_;
    my %route = $self->getRouteFromMetaDataURL( $key, $index, $sub );
    return unless (%route);
    $self->addUnauthRoute( %route, $methods );
}

Yadd's avatar
Yadd committed
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
## @method boolean processLogoutResponseMsg(Lasso::Logout logout, string response)
# Process logout response message
# @param logout Lasso::Logout object
# @param response SAML response
# @return result
sub processLogoutResponseM