openstackid/app/libs/OpenId/OpenIdProtocol.php
smarcet b52c932636 IDP - User Management
* Added user registration process
* Added user password reset process
* Added user email verification proccess
* update token id to return custom claims
* update access token instrospection to return user custom claims
* Migrated to Doctrine ORM ( from eloquent)
* Added User CRUD
* Added User Groups CRUD
* Refactoring
* Bug Fixing
* added user registration oauth2 endpoint
  POST /api/v1/user-registration-requests

payload

* first_name ( required )
* last_name ( required)
* email ( required )
* country ( optional )

scope

user-registration ( private scope)

Change-Id: I36e8cd4473ccad734565051442e2c6033b204f27
2020-01-23 03:06:05 -03:00

224 lines
10 KiB
PHP

<?php namespace OpenId;
/**
* Copyright 2016 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use OpenId\Handlers\IOpenIdAuthenticationStrategy;
use OpenId\Handlers\OpenIdAuthenticationRequestHandler;
use OpenId\Handlers\OpenIdCheckAuthenticationRequestHandler;
use OpenId\Handlers\OpenIdSessionAssociationRequestHandler;
use OpenId\Services\IAssociationService;
use OpenId\Services\IMementoOpenIdSerializerService;
use OpenId\Services\INonceService;
use OpenId\Services\IServerConfigurationService;
use OpenId\Services\IServerExtensionsService;
use OpenId\Services\ITrustedSitesService;
use OpenId\Xrds\XRDSDocumentBuilder;
use OpenId\Xrds\XRDSService;
use Utils\Services\IAuthService;
use Utils\Services\ICheckPointService;
use Utils\Services\ILogService;
use Utils\Services\IServerConfigurationService as IUtilsServerConfigurationService;
/**
* Class OpenIdProtocol
* OpenId Protocol Implementation
* @package OpenId
*/
class OpenIdProtocol implements IOpenIdProtocol
{
const OpenIdPrefix = "openid";
//protocol constants
const OPIdentifierType = "http://specs.openid.net/auth/2.0/server";
const ClaimedIdentifierType = "http://specs.openid.net/auth/2.0/signon";
const OpenID2MessageType = "http://specs.openid.net/auth/2.0";
const IdentifierSelectType = "http://specs.openid.net/auth/2.0/identifier_select";
const ImmediateMode = "checkid_immediate";
const SetupMode = "checkid_setup";
const IdMode = "id_res";
const SetupNeededMode = "setup_needed";
const CancelMode = "cancel";
const CheckAuthenticationMode = "check_authentication";
const ErrorMode = "error";
const AssociateMode = "associate";
const SignatureAlgorithmHMAC_SHA1 = "HMAC-SHA1";
const SignatureAlgorithmHMAC_SHA256 = "HMAC-SHA256";
const AssociationSessionTypeNoEncryption = "no-encryption";
const AssociationSessionTypeDHSHA1 = "DH-SHA1";
const AssociationSessionTypeDHSHA256 = "DH-SHA256";
const OpenIDProtocol_Mode = "mode";
const OpenIDProtocol_NS = "ns";
const OpenIDProtocol_ReturnTo = "return_to";
const OpenIDProtocol_ClaimedId = "claimed_id";
const OpenIDProtocol_Identity = "identity";
const OpenIDProtocol_AssocHandle = "assoc_handle";
const OpenIDProtocol_Realm = "realm";
const OpenIDProtocol_OpEndpoint = "op_endpoint";
const OpenIDProtocol_Nonce = "response_nonce";
const OpenIDProtocol_InvalidateHandle = "invalidate_handle";
const OpenIDProtocol_Signed = "signed";
const OpenIDProtocol_Sig = "sig";
const OpenIDProtocol_Error = "error";
const OpenIDProtocol_ErrorCode = "error_code";
const OpenIDProtocol_Contact = "contact";
const OpenIDProtocol_Reference = "reference";
const OpenIDProtocol_IsValid = "is_valid";
const OpenIDProtocol_AssocType = "assoc_type";
const OpenIDProtocol_SessionType = "session_type";
const OpenIdProtocol_DHModulus = "dh_modulus";
const OpenIdProtocol_DHGen = "dh_gen";
const OpenIdProtocol_DHConsumerPublic = "dh_consumer_public";
const OpenIdProtocol_ExpiresIn = "expires_in";
const OpenIdProtocol_DHServerPublic = "dh_server_public";
const OpenIdProtocol_DHEncMacKey = "enc_mac_key";
const OpenIdProtocol_MacKey = "mac_key";
private static $OpenIDProtocol_SupportedAssocType = array(
self::SignatureAlgorithmHMAC_SHA1,
self::SignatureAlgorithmHMAC_SHA256,
self::AssociationSessionTypeNoEncryption,
);
private static $OpenIDProtocol_SupportedSessionType = array(
self::AssociationSessionTypeNoEncryption,
self::AssociationSessionTypeDHSHA1,
self::AssociationSessionTypeDHSHA256
);
private static $OpenIDProtocol_ValidModes = array(
self::ImmediateMode,
self::SetupMode,
self::IdMode,
self::SetupNeededMode,
self::CancelMode,
self::CheckAuthenticationMode,
self::ErrorMode,
self::AssociateMode,
);
private static $protocol_definition = array(
self::OpenIDProtocol_Mode => self::OpenIDProtocol_Mode,
self::OpenIDProtocol_NS => self::OpenIDProtocol_NS,
self::OpenIDProtocol_ReturnTo => self::OpenIDProtocol_ReturnTo,
self::OpenIDProtocol_ClaimedId => self::OpenIDProtocol_ClaimedId,
self::OpenIDProtocol_Identity => self::OpenIDProtocol_Identity,
self::OpenIDProtocol_AssocHandle => self::OpenIDProtocol_AssocHandle,
self::OpenIDProtocol_Realm => self::OpenIDProtocol_Realm,
self::OpenIDProtocol_OpEndpoint => self::OpenIDProtocol_OpEndpoint,
self::OpenIDProtocol_Nonce => self::OpenIDProtocol_Nonce,
self::OpenIDProtocol_InvalidateHandle => self::OpenIDProtocol_InvalidateHandle,
self::OpenIDProtocol_Signed => self::OpenIDProtocol_Signed,
self::OpenIDProtocol_Sig => self::OpenIDProtocol_Sig,
self::OpenIDProtocol_Error => self::OpenIDProtocol_Error,
self::OpenIDProtocol_ErrorCode => self::OpenIDProtocol_ErrorCode,
self::OpenIDProtocol_Contact => self::OpenIDProtocol_Contact,
self::OpenIDProtocol_Reference => self::OpenIDProtocol_Reference,
self::OpenIDProtocol_IsValid => self::OpenIDProtocol_IsValid,
self::OpenIDProtocol_AssocType => self::OpenIDProtocol_AssocType,
self::OpenIDProtocol_SessionType => self::OpenIDProtocol_SessionType,
self::OpenIdProtocol_DHModulus => self::OpenIdProtocol_DHModulus,
self::OpenIdProtocol_DHGen => self::OpenIdProtocol_DHGen,
self::OpenIdProtocol_DHConsumerPublic => self::OpenIdProtocol_DHConsumerPublic,
self::OpenIdProtocol_ExpiresIn => self::OpenIdProtocol_ExpiresIn,
self::OpenIdProtocol_DHServerPublic => self::OpenIdProtocol_DHServerPublic,
self::OpenIdProtocol_DHEncMacKey => self::OpenIdProtocol_DHEncMacKey,
self::OpenIdProtocol_MacKey => self::OpenIdProtocol_MacKey,
);
/**
* @var OpenIdAuthenticationRequestHandler
*/
private $request_handlers;
/**
* @var IServerExtensionsService
*/
private $server_extension_service;
/**
* @var IServerConfigurationService
*/
private $server_config_service;
/**
* @param IAuthService $auth_service
* @param IMementoOpenIdSerializerService $memento_request_service
* @param IOpenIdAuthenticationStrategy $auth_strategy
* @param IServerExtensionsService $server_extension_service
* @param IAssociationService $association_service
* @param ITrustedSitesService $trusted_sites_service
* @param IServerConfigurationService $server_config_service
* @param INonceService $nonce_service
* @param ILogService $log_service
* @param ICheckPointService $checkpoint_service
* @param IUtilsServerConfigurationService $utils_configuration_service
*/
public function __construct(
IAuthService $auth_service,
IMementoOpenIdSerializerService $memento_request_service,
IOpenIdAuthenticationStrategy $auth_strategy,
IServerExtensionsService $server_extension_service,
IAssociationService $association_service,
ITrustedSitesService $trusted_sites_service,
IServerConfigurationService $server_config_service,
INonceService $nonce_service,
ILogService $log_service,
ICheckPointService $checkpoint_service,
IUtilsServerConfigurationService $utils_configuration_service)
{
//create chain of responsibility
$check_auth = new OpenIdCheckAuthenticationRequestHandler($association_service, $nonce_service, $log_service,$checkpoint_service,$utils_configuration_service,$server_config_service, null);
$session_assoc = new OpenIdSessionAssociationRequestHandler($log_service,$checkpoint_service, $check_auth);
$this->request_handlers = new OpenIdAuthenticationRequestHandler($auth_service, $memento_request_service, $auth_strategy, $server_extension_service, $association_service, $trusted_sites_service, $server_config_service, $nonce_service, $log_service,$checkpoint_service, $session_assoc);
$this->server_extension_service = $server_extension_service;
$this->server_config_service = $server_config_service;
}
public static function isAssocTypeSupported($assoc_type)
{
return in_array($assoc_type, self::$OpenIDProtocol_SupportedAssocType);
}
public static function isSessionTypeSupported($session_type)
{
return in_array($session_type, self::$OpenIDProtocol_SupportedSessionType);
}
/**
* check if a provide message mode is valid or not in openid 2.0 protocol
* @param $mode
* @return bool
*/
public static function isValidMode($mode)
{
return in_array($mode, self::$OpenIDProtocol_ValidModes);
}
public static function param($param, $separator = '.')
{
return self::OpenIdPrefix . $separator . $param ;
}
public function getXRDSDiscovery($mode, $canonical_id = null)
{
$active_extensions = $this->server_extension_service->getAllActiveExtensions();
$extensions = [];
foreach ($active_extensions as $ext) {
array_push($extensions, $ext->getNamespace());
}
$services = [];
array_push($services, new XRDSService(0, $mode == IOpenIdProtocol::OpenIdXRDSModeUser ? self::ClaimedIdentifierType : self::OPIdentifierType, $this->server_config_service->getOPEndpointURL(), $extensions, $canonical_id));
$builder = new XRDSDocumentBuilder($services, $canonical_id);
$xrds = $builder->render();
return $xrds;
}
public function handleOpenIdMessage(OpenIdMessage $openIdMessage)
{
return $this->request_handlers->handleMessage($openIdMessage);
}
}