## @file # SAML Service Provider - Authentication ## @class # SAML Service Provider - Authentication package Lemonldap::NG::Portal::AuthSAML; use strict; use Lemonldap::NG::Portal::Simple; use Lemonldap::NG::Portal::_SAML; #inherits use Lemonldap::NG::Common::Conf::SAML::Metadata; our $VERSION = '0.1'; ## @apmethod int authInit() # Load Lasso and metadata # @return Lemonldap::NG::Portal error code sub authInit { my $self = shift; # Load Lasso return PE_ERROR unless $self->loadLasso(); # Activate SOAP $self->abort( 'To use SAML, you must activate SOAP (Soap => 1)', 'error' ) unless ( $self->{Soap} ); # Check presence of private key in configuration unless ( $self->{samlServicePrivateKey} ) { $self->lmLog( "SAML private key not found in configuration", 'error' ); return PE_ERROR; } # Get metadata from configuration $self->lmLog( "Get Metadata for this service", 'debug' ); my $service_metadata = Lemonldap::NG::Common::Conf::SAML::Metadata->new(); # Create Lasso server with service metadata my $server = $self->createServer( $service_metadata->serviceToXML( $ENV{DOCUMENT_ROOT} . "/skins/common/saml2-metadata.tpl", $self ), $self->{samlServicePrivateKey}, ); unless ($server) { $self->lmLog( 'Unable to create Lasso server', 'error' ); return PE_ERROR; } $self->lmLog( "Service created", 'debug' ); # Check presence of at least one identity provider in configuration unless ( $self->{samlIDPMetaData} and keys %{ $self->{samlIDPMetaData} } ) { $self->lmLog( "No IDP found in configuration", 'error' ); return PE_ERROR; } # Load identity provider metadata # IDP are listed in $self->{samlIDPMetaData} # Each key is the IDP name # Build IDP list for later use in extractFormInfo foreach ( keys %{ $self->{samlIDPMetaData} } ) { $self->lmLog( "Get Metadata for IDP $_", 'debug' ); # Get metadata from configuration my $idp_metadata = Lemonldap::NG::Common::Conf::SAML::Metadata->new(); unless ( $idp_metadata->initializeFromConfHash( $self->{samlIDPMetaData}->{$_}->{samlIDPMetaDataXML} ) ) { $self->lmLog( "Fail to read IDP $_ Metadata from configuration", 'error' ); return PE_ERROR; } # Add this IDP to Lasso::Server my $result = $self->addIDP( $server, $idp_metadata->toXML() ); unless ($result) { $self->lmLog( "Fail to use IDP $_ Metadata", 'error' ); return PE_ERROR; } # Store IDP entityID and Organization Name my $entityID = $idp_metadata->{entityID}; my $name = $self->getOrganizationName( $server, $entityID ) || ucfirst($_); $self->{_idpList}->{$_}->{entityID} = $entityID; $self->{_idpList}->{$_}->{name} = $name; $self->lmLog( "IDP $_ added", 'debug' ); } # Store Lasso::Server object $self->{_lassoServer} = $server; PE_OK; } ## @apmethod int extractFormInfo() # Check authentication statement or create authentication request # @return Lemonldap::NG::Portal error code sub extractFormInfo { my $self = shift; my $server = $self->{_lassoServer}; my $login; my $logout; my $idp; my $method; my $request; my $response; my %h; # 1. Get HTTP request informations to know # if we are receving SAML request or response my $url = $self->url(); my $request_method = $self->request_method(); my $content_type = $self->content_type(); my $saml_acs_art_url = $self->getMetaDataURL( "samlSPSSODescriptorAssertionConsumerServiceHTTPArtifact"); my $saml_acs_post_url = $self->getMetaDataURL( "samlSPSSODescriptorAssertionConsumerServiceHTTPPost"); my $saml_acs_get_url = $self->getMetaDataURL( "samlSPSSODescriptorAssertionConsumerServiceHTTPRedirect"); my $saml_slo_soap_url = $self->getMetaDataURL( "samlSPSSODescriptorSingleLogoutServiceSOAP", 1 ); my $saml_slo_soap_url_ret = $self->getMetaDataURL( "samlSPSSODescriptorSingleLogoutServiceSOAP", 2 ); my $saml_slo_get_url = $self->getMetaDataURL( "samlSPSSODescriptorSingleLogoutServiceHTTP", 1 ); my $saml_slo_get_url_ret = $self->getMetaDataURL( "samlSPSSODescriptorSingleLogoutServiceHTTP", 2 ); # 1.1 SSO assertion consumer if ( $url =~ /^($saml_acs_art_url|$saml_acs_post_url|$saml_acs_get_url)$/i ) { $self->lmLog( "URL $url detected as an SSO assertion consumer URL", 'debug' ); # Create Login object $login = $self->createLogin($server); # 1.1.1 HTTP REDIRECT if ( $url =~ /^$saml_acs_get_url$/i ) { # Response in query string $response = $self->query_string(); $self->lmLog( "HTTP-REDIRECT: SAML Response $response", 'debug' ); # Process authentication response my $result = $self->processAuthnResponseMsg( $login, $response ); unless ($result) { $self->lmLog( "HTTP-REDIRECT: Fail to process authentication response", 'error' ); return PE_ERROR; } $self->lmLog( "HTTP-REDIRECT: authentication response is valid", 'debug' ); } # 1.1.2 POST # TODO # 1.1.3 ARTEFACT (SOAP) # TODO # Get SAML response my $saml_response = $login->response(); unless ($saml_response) { $self->lmLog( "No SAML response found", 'error' ); return PE_ERROR; } # Replay protection if this is a response to a created authn request my $assertion_responded = $saml_response->InResponseTo; if ($assertion_responded) { my $assertion_sessions = $self->{globalStorage}->searchOn( $self->{globalStorageOptions}, "ID", $assertion_responded, ); if ( my @assertion_keys = keys %$assertion_sessions ) { # A session was found foreach (@assertion_keys) { my $assertion_session = $_; # Delete it eval { tie %h, $self->{globalStorage}, $_, $self->{globalStorageOptions}; }; if ($@) { $self->lmLog( "Unable to recover assertion session $assertion_session (assertion ID $assertion_responded)", 'error' ); return PE_ERROR; } eval { tied(%h)->delete(); }; if ($@) { $self->lmLog( "Unable to delete assertion session $assertion_session (assertion ID $assertion_responded)", 'error' ); return PE_ERROR; } $self->lmLog( "Assertion session $assertion_session (assertion ID $assertion_responded) was deleted", 'debug' ); } } else { # Assertion was already consumed or is expired # Force authentication replay $self->lmLog( "Assertion $assertion_responded already used or expired, replay authentication", 'error' ); delete $self->{urldc}; $self->{mustRedirect} = 1; $self->{error} = $self->_subProcess(qw(autoRedirect)); return $self->{error}; } } else { $self->lmLog( "Assertion is not a response to a created authentication request, do not control replay", 'debug' ); } # Get SAML assertion my $assertion = $self->getAssertion($login); unless ($assertion) { $self->lmLog( "No assertion found", 'error' ); return PE_ERROR; } # Check conditions - time and audience unless ( $self->validateConditions( $assertion, $self->{samlEntityID} ) ) { $self->lmLog( "Time or Audience conditions not validated", 'error' ); return PE_ERROR; } $self->lmLog( "Conditions validated", 'debug' ); # Check OneTimeUse flag # TODO # Check ProxyRestriction flag # TODO # Extract RelayState information if ( $self->extractRelayState($login) ) { $self->lmLog( "RelayState found in authentication assertion", 'debug' ); } # Check IDP from RelayState my $idp = $self->{_idp}; if ($idp) { $self->lmLog( "IDP $idp found in RelayState", 'debug' ); } else { # Try to recover IDP from IDP cookie my %cookies = fetch CGI::Cookie; my $idp_cookie = $cookies{ $self->{samlIdPResolveCookie} }; if ($idp_cookie) { $idp = $idp_cookie->value; $self->{_idp} = $idp; $self->lmLog( "IDP $idp found in IDP resolution cookie", 'debug' ); } else { $self->lmLog( "IDP was not found in RelayState or in IDP resolution cookie", 'error' ); return PE_ERROR; } } # Force redirection to portal if no urldc found # (avoid displaying the whole SAML URL in user browser URL field) $self->{mustRedirect} = 1 unless ( $self->{urldc} ); # Get NameID my $nameid = $login->nameIdentifier; # Set user my $user = $nameid->content; unless ($user) { $self->lmLog( "No NameID value found", 'error' ); return PE_USERNOTFOUND; } $self->lmLog( "Find NameID: $user", 'debug' ); $self->{user} = $user; # Store Lasso objects $self->{_lassoLogin} = $login; return PE_OK; } # 1.2 SLO if ( $url =~ /^($saml_slo_soap_url|$saml_slo_soap_url_ret|$saml_slo_get_url|$saml_slo_get_url_ret)$/i ) { $self->lmLog( "URL $url detected as an SLO URL", 'debug' ); # Create Logout object $logout = $self->createLogout($server); # 1.2.1 HTTP-REDIRECT if ( $self->request_method() =~ /^GET$/ ) { $method = Lasso::Constants::HTTP_METHOD_REDIRECT; $self->lmLog( "SLO method: HTTP-REDIRECT", 'debug' ); if ( $self->param('SAMLResponse') ) { # Response in query string $response = $self->query_string(); $self->lmLog( "HTTP-REDIRECT: SAML Response $response", 'debug' ); } if ( $self->param('SAMLRequest') ) { # Request in query string $response = $self->query_string(); $self->lmLog( "HTTP-REDIRECT: SAML Request $request", 'debug' ); } } elsif ( $self->request_method() =~ /^POST$/ ) { # 1.2.2 POST if ( $self->content_type() !~ /xml/ ) { $method = Lasso::Constants::HTTP_METHOD_POST; $self->lmLog( "SLO method: HTTP-POST", 'debug' ); if ( $self->param('SAMLResponse') ) { # Response in body part $response = $self->param('SAMLResponse'); $self->lmLog( "HTTP-POST: SAML Response $response", 'debug' ); } if ( $self->param('SAMLRequest') ) { # Request in body part $response = $self->param('SAMLRequest'); $self->lmLog( "HTTP-POST: SAML Request $request", 'debug' ); } } # 1.2.3 SOAP else { $method = Lasso::Constants::HTTP_METHOD_SOAP; $self->lmLog( "SLO method: HTTP-SOAP", 'debug' ); # SOAP is always a request $request = $self->param('POSTDATA'); $self->lmLog( "HTTP-SOAP: SAML Request $request", 'debug' ); } } if ($response) { # Process logout response my $result = $self->processLogoutResponseMsg( $logout, $response ); unless ($result) { $self->lmLog( "Fail to process logout response", 'error' ); return PE_ERROR; } $self->lmLog( "Logout response is valid", 'debug' ); # TODO replay protection # Inform user that logout is OK return PE_LOGOUT_OK; } elsif ($request) { # Logout error my $logout_error = 0; # Lasso::Session dump my $session_dump; # Process logout request unless ( $self->processLogoutRequestMsg( $logout, $request ) ) { $self->lmLog( "Fail to process logout request", 'error' ); return PE_ERROR; } $self->lmLog( "Logout request is valid", 'debug' ); # Get NameID and SessionIndex my $name_id = $logout->request()->NameID; my $session_index = $logout->request()->SessionIndex; my $user = $name_id->content; unless ($user) { $self->lmLog( "Fail to get NameID content from logout request", 'error' ); return PE_ERROR; } $self->lmLog( "Logout request NameID content: $user", 'debug' ); # Get corresponding session my $local_sessions = $self->{globalStorage} ->searchOn( $self->{globalStorageOptions}, "_user", $user, ); if ( my @local_sessions_keys = keys %$local_sessions ) { # A session was found foreach (@local_sessions_keys) { my $local_session = $_; # Get session $self->lmLog( "Retrieve session $local_session for user $user", 'debug' ); my $sessionInfo = $self->getApacheSession( $local_session, 1 ); # Get Lasso::Session dump $session_dump = $sessionInfo->{_lassoSessionDump} if $sessionInfo->{_lassoSessionDump}; # TODO test SessionIndex to be sure to select the correct session # Delete Session $self->lmLog( "Delete session $local_session for user $user", 'debug' ); my $logout_result = $self->_deleteSession($sessionInfo); $self->lmLog( "Local Logout result: $logout_result", 'debug' ); $logout_error = 1 unless $logout_result; } # Set session from dump unless ( $self->setSessionFromDump( $logout, $session_dump ) ) { $self->lmLog( "Cannot set session from dump in logout", 'error' ); return PE_ERROR; } # Validate request unless ( $self->validateLogoutRequest($logout) ) { $self->lmLog( "SLO request is not valid", 'error' ); return PE_ERROR; } } else { # No corresponding session found $self->lmLog( "No local session found for user $user", 'debug' ); return PE_ERROR; } # Logout response unless ( $self->buildLogoutResponseMsg($logout) ) { $self->lmLog( "Unable to build SLO response", 'error' ); return PE_ERROR; } # Send response depending on request method # HTTP-REDIRECT if ( $method == Lasso::Constants::HTTP_METHOD_REDIRECT ) { # Redirect user to response URL my $slo_url = $logout->msg_url; $self->lmLog( "Redirect user to $slo_url", 'debug' ); $self->{urldc} = $slo_url; $self->{error} = $self->_subProcess(qw(autoRedirect)); return $self->{error}; } # HTTP-POST if ( $method == Lasso::Constants::HTTP_METHOD_POST ) { # TODO } # HTTP-SOAP if ( $method == Lasso::Constants::HTTP_METHOD_SOAP ) { my $slo_body = $logout->msg_body; $self->lmLog( "SOAP response $slo_body", 'debug' ); $self->{SOAPMessage} = $slo_body; $self->_subProcess(qw(returnSOAPMessage)); # If we are here, there was a problem with SOAP response $self->lmLog( "Logout response was not sent trough SOAP", 'error' ); return PE_ERROR; } } else { # This should not happen $self->lmLog( "SLO request or response was not found", 'error' ); # Redirect user $self->{mustRedirect} = 1; $self->{error} = $self->_subProcess(qw(autoRedirect)); return $self->{error}; } } # 2. IDP resolution # Get IDP resolution cookie my %cookies = fetch CGI::Cookie; my $idp_cookie = $cookies{ $self->{samlIdPResolveCookie} }; if ($idp_cookie) { $idp = $idp_cookie->value; $self->lmLog( "IDP $idp found in IDP resolution cookie", 'debug' ); } # If no IDP resolve cookie, find another way to get it # Case 1: IDP was choosen from portal IDP list $idp ||= $self->param("idp"); # TODO - other case (IP resolution, etc.) # Get confirmation flag my $confirm_flag = $self->param("confirm"); # If confirmation is -1, or IDP was not resolve, let the user choose its IDP if ( $confirm_flag == -1 or !$idp ) { $self->lmLog( "No IDP found, redirecting user to IDP list", 'debug' ); # IDP list my $html = "
' . $self->{_idpList}->{$_}->{name} . ' | |
' . &Lemonldap::NG::Portal::_i18n::msg( PM_REMEMBERCHOICE, $ENV{HTTP_ACCEPT_LANGUAGE} ) . " |