laminas-api-tools/api-tools-mvc-auth

Laminas 模块,提供身份验证和授权事件及基础设施


README

Build Status

🇷🇺 俄罗斯公民

我们,Laminas 的参与者,来自不同的国家。我们中许多人有在俄罗斯和乌克兰的朋友、亲戚和同事。我们中的一些人生于俄罗斯。我们中的一些人目前住在俄罗斯。我们中的一些人的祖父母曾在二战中与法西斯作战。在这里,没有人支持法西斯主义。

我们中的一位成员有一位乌克兰亲戚,她带着儿子逃离了家园。由于前方道路上的轰炸,火车延误了。我们有朋友躲在防空洞里。在空袭之后,我们焦急地等待他们的消息,空袭无差别地攻击医院、学校、幼儿园和房屋。我们不是从任何媒体上得到这些消息的。这是我们亲眼目睹的。

您足够信任我们,使用我们的程序,我们请求您再次信任我们。我们需要您的帮助。走出家门,抗议这场毫无意义的战争。停止杀戮。说“不,战争!”

🇺🇸 俄罗斯公民

我们来自世界各地。我们中许多人有在俄罗斯和乌克兰的朋友、家人和同事。我们中的一些人生于俄罗斯。我们中的一些人目前住在俄罗斯。我们中的一些人的祖父母曾在二战中与纳粹作战。在这里,没有人支持法西斯主义。

我们的一位团队成员有一位乌克兰亲戚,她带着儿子逃离了家园。由于前方道路上的轰炸,火车延误了。我们有朋友躲在防空洞里。在空袭之后,我们焦急地等待他们的消息,空袭无差别地攻击医院、学校、幼儿园和房屋。我们不是从任何媒体上得到这些消息的。这是我们亲身经历的。

您足够信任我们,使用我们的软件。我们请求您信任我们说出真相。我们需要您的帮助。走出家门,抗议这场不必要的战争。停止杀戮。说“停止战争!”

介绍

api-tools-mvc-auth 是一个 Laminas 模块,它增加了服务、事件和配置,扩展了基本的 Laminas MVC 生命周期,以处理身份验证和授权。

对于身份验证,默认支持 3 种主要方法:HTTP Basic 身份验证、HTTP Digest 身份验证和 OAuth2(这需要 Brent Shaffer 的 OAuth2 服务器)。

对于授权,此特定模块提供了一个预调度时间监听器,该监听器将确定给定的路由是否匹配,以及 HTTP 方法是否被授权进行调度。

要求

请参阅 composer.json 文件。

安装

运行以下 composer 命令

$ composer require "laminas-api-tools/api-tools-mvc-auth"

或者,手动将以下内容添加到您的 composer.json 中的 require 部分

"require": {
    "laminas-api-tools/api-tools-mvc-auth": "^1.4"
}

然后运行 composer update 确保模块已安装。

最后,将模块名称添加到项目的 config/application.config.php 中的 modules 键下

return [
    /* ... */
    'modules' => [
        /* ... */
        'Laminas\ApiTools\MvcAuth',
    ],
    /* ... */
];

配置

用户配置

此模块用户配置的最高级配置键是 api-tools-mvc-auth。在此键下,有两个子键,一个用于 authentication,另一个用于 authorization

键:authentication

authentication 键用于任何与认证过程或验证身份过程相关的配置。

子键:http

http 子键用于配置基于 HTTP 的认证方案。这些方案使用 Laminas 的 Laminas\Authentication\Adapter\Http 适配器,该适配器实现了 HTTP Basic 和 HTTP Digest 认证。为此,HTTP 适配器使用基于文件的 "resolver" 来解析包含凭证的文件。这些实现细节可以在 Laminas 手册的认证部分 中找到。

http 子键有多个字段

  • accept_schemes必需;配置的方案数组;一个或两个 basicdigest
  • realm必需;通常是一个标识 HTTP 域的字符串;例如,"我的网站"。
  • digest_domains必需 对于 HTTP Digest;受保护区域的相对 URI,通常是 /
  • nonce_timeout必需 对于 HTTP Digest;摘要 nonce 过期的时间(秒),通常是 3600

除了这些配置选项之外,还需要以下一个或两个 resolver 配置

  • htpasswd:创建在 htpasswd 文件格式中的文件的路径
  • htdigest:创建在 htdigest 文件格式中的文件的路径

以下是一个示例

'http' => [
    'accept_schemes' => ['basic', 'digest'],
    'realm' => 'My Web Site',
    'digest_domains' => '/',
    'nonce_timeout' => 3600,
    'htpasswd' => APPLICATION_PATH . '/data/htpasswd', // htpasswd tool generated
    'htdigest' => APPLICATION_PATH . '/data/htdigest', // @see http://www.askapache.com/online-tools/htpasswd-generator/
],
子键:map
  • 自 1.1.0 版本以来。

map 子键用于将 API 模块(可选,带有版本命名空间)映射到给定的认证类型(通常是 basicdigestoauth2)。这可以用于为不同的 API 或同一 API 的不同版本强制执行不同的认证方法。

return [
    'api-tools-mvc-auth' => [
        'authentication' => [
            'map' => [
                'Status\V1' => 'basic',  // v1 only!
                'Status\V2' => 'oauth2', // v2 only!
                'Ping'      => 'digest', // all versions!
            ],
        ],
    ],
];

如果没有 map 子键,则如果定义了任何认证适配器配置,则该配置将用于任何 API。

1.0 版本迁移用户注意:在 1.0 系列中,认证是 按应用程序 的,而不是按 API 的。迁移到 1.1 应该是无缝的;如果您未编辑您的认证设置或向任何 API 提供认证信息,则您的 API 将继续像以前一样工作。您首次执行这些操作之一时,Admin API 将创建一个映射,将每个服务的每个版本映射到配置的认证方案,从而确保您的 API 继续按之前配置的方式工作,同时让您在未来能够定义按 API 和按版本进行认证的灵活性。

子键:types
  • 自 1.1.0 版本以来。

从 1.1.0 版本开始,提供了认证适配器的概念。适配器 "提供" 一个或多个认证类型;然后内部使用这些类型来确定使用哪个适配器,以及由 Admin API 使用以将 API 映射到特定的认证类型。

在某些情况下,您可能正在使用监听器或其他用于认证 API 的设施。为了允许映射这些(在这种情况下主要是文档功能),存在 types 子键。此键是一个字符串认证类型的数组

return [
    'api-tools-mvc-auth' => [
        'authentication' => [
            'types' => [
                'token',
                'key',
            ],
        ],
    ],
];

此键及其内容 必须 手动创建。

子键:adapters
  • 自 1.1.0 版本以来。

从 1.1.0 版本开始,随着适配器的引入,您还可以配置命名的 HTTP 和 OAuth2 适配器。提供的名称将用作将 API 映射到认证适配器的认证类型。

adapters 键的格式是键/值对,键作为类型,值作为提供 Laminas\ApiTools\MvcAuth\Authentication\HttpAdapterLaminas\ApiTools\MvcAuth\Authentication\OAuth2Adapter 实例的配置,如下所示

return [
    'api-tools-mvc-auth' => [
        'authentication' => [
            'adapters' => [
                'api' => [
                    // This defines an HTTP adapter that can satisfy both
                    // basic and digest.
                    'adapter' => 'Laminas\ApiTools\MvcAuth\Authentication\HttpAdapter',
                    'options' => [
                        'accept_schemes' => ['basic', 'digest'],
                        'realm' => 'api',
                        'digest_domains' => 'https://example.com',
                        'nonce_timeout' => 3600,
                        'htpasswd' => 'data/htpasswd',
                        'htdigest' => 'data/htdigest',
                    ],
                ],
                'user' => [
                    // This defines an OAuth2 adapter backed by PDO.
                    'adapter' => 'Laminas\ApiTools\MvcAuth\Authentication\OAuth2Adapter',
                    'storage' => [
                        'adapter' => 'pdo',
                        'dsn' => 'mysql:host=localhost;dbname=oauth2',
                        'username' => 'username',
                        'password' => 'password',
                        'options' => [
                            1002 => 'SET NAMES utf8', // PDO::MYSQL_ATTR_INIT_COMMAND
                        ],
                    ],
                ],
                'client' => [
                    // This defines an OAuth2 adapter backed by Mongo.
                    'adapter' => 'Laminas\ApiTools\MvcAuth\Authentication\OAuth2Adapter',
                    'storage' => [
                        'adapter' => 'mongo',
                        'locator_name' => 'SomeServiceName', // If provided, pulls the given service
                        'dsn' => 'mongodb://localhost',
                        'database' => 'oauth2',
                        'options' => [
                            'username' => 'username',
                            'password' => 'password',
                            'connectTimeoutMS' => 500,
                        ],
                    ],
                ],
            ],
        ],
    ],
];

键:authorization

子键:deny_by_default

deny_by_default 切换 Laminas\Permissions\Acl 实现的默认行为。默认值为 false,表示如果没有认证用户,且没有权限规则应用于当前资源,则允许访问。将此设置更改为 true 以默认要求认证身份。

示例

'deny_by_default' => false,
与 api-tools-oauth2 一起使用 deny_by_default

当使用 deny_by_default => trueapi-tools-oauth2 时,您需要显式允许 OAuth2 控制器上的 POST,以便进行认证请求。

例如

'authorization' => [
    'deny_by_default' => true,
    'Laminas\\ApiTools\\OAuth2\\Controller\\Auth' => [
        'actions' => [
            'token' => [
                'GET'    => false,
                'POST'   => true,   // <-----
                'PATCH'  => false,
                'PUT'    => false,
                'DELETE' => false,
            ],
        ],
    ],
],
在 apache2 上启用 deny_by_default

如果您在 Apache 2 上部署项目并启用了 deny_by_default,您可能会观察到 API 返回 "403 禁止" 响应。这是由于 api-tools-mvc-auth 依赖的上游库 问题 bshaffer/oauth2-server-php#503。解决方案是在您的 .htaccess 文件或 Apache 配置中添加以下行

RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

如果您在 nginx 或您的 Apache 2 实例后面有反向代理,您将不会受到此问题的影响。

子键:控制器服务名称

authorization 键下是一个以 控制器服务名称 为键的授权配置设置数组。这些数组的结构取决于您尝试授予或限制访问的控制器服务的类型。

对于典型的基于 Laminas 的动作控制器,此数组以 actions 为键。在此键下,给定控制器服务的每个动作名称都与一个 权限数组 相关联。

对于基于 api-tools-rest 的控制器,使用顶级键 collectionentity。在这些键下将有一个相关的 权限数组

权限数组 由一个键为数组的 default 或 HTTP 方法组成。每个这些的值都是一个布尔值,其中 true 表示 需要认证用户,而 false 表示 不需要认证用户。如果一个动作或 HTTP 方法未标识,则假设默认值。如果没有默认值,则假设上述讨论的 deny_by_default 键的行为。

以下是一个示例

'authorization' => [
    'Controller\Service\Name' => [
        'actions' => [
            'action' => [
                'default' => boolean,
                'GET' => boolean,
                'POST' => boolean,
                // etc.
            ],
        ],
        'collection' => [
            'default' => boolean,
            'GET' => boolean,
            'POST' => boolean,
            // etc.
        ],
        'entity' => [
            'default' => boolean,
            'GET' => boolean,
            'POST' => boolean,
            // etc.
        ],
    ],
],

系统配置

以下配置在 config/module.config.php 中提供,以启用模块功能

'service_manager' => [
    'aliases' => [
        'authentication' => 'Laminas\ApiTools\MvcAuth\Authentication',
        'authorization' => 'Laminas\ApiTools\MvcAuth\Authorization\AuthorizationInterface',
        'Laminas\ApiTools\MvcAuth\Authorization\AuthorizationInterface' => 'Laminas\ApiTools\MvcAuth\Authorization\AclAuthorization',
    ],
    'factories' => [
        'Laminas\ApiTools\MvcAuth\Authentication' => 'Laminas\ApiTools\MvcAuth\Factory\AuthenticationServiceFactory',
        'Laminas\ApiTools\MvcAuth\ApacheResolver' => 'Laminas\ApiTools\MvcAuth\Factory\ApacheResolverFactory',
        'Laminas\ApiTools\MvcAuth\FileResolver' => 'Laminas\ApiTools\MvcAuth\Factory\FileResolverFactory',
        'Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationListener' => 'Laminas\ApiTools\MvcAuth\Factory\DefaultAuthenticationListenerFactory',
        'Laminas\ApiTools\MvcAuth\Authentication\AuthHttpAdapter' => 'Laminas\ApiTools\MvcAuth\Factory\DefaultAuthHttpAdapterFactory',
        'Laminas\ApiTools\MvcAuth\Authorization\AclAuthorization' => 'Laminas\ApiTools\MvcAuth\Factory\AclAuthorizationFactory',
        'Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationListener' => 'Laminas\ApiTools\MvcAuth\Factory\DefaultAuthorizationListenerFactory',
        'Laminas\ApiTools\MvcAuth\Authorization\DefaultResourceResolverListener' => 'Laminas\ApiTools\MvcAuth\Factory\DefaultResourceResolverListenerFactory',
    ],
    'invokables' => [
        'Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationPostListener' => 'Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationPostListener',
        'Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationPostListener' => 'Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationPostListener',
    ],
],

这些服务将在事件和服务部分中描述。

Laminas 事件

事件

Laminas\ApiTools\MvcAuth\MvcAuthEvent::EVENT_AUTHENTICATION (即 "认证")

此事件在 MvcEvent::EVENT_ROUTE 时触发,优先级为 500。它通过 Laminas\ApiTools\MvcAuth\MvcRouteListener 事件监听器聚合注册。

Laminas\ApiTools\MvcAuth\MvcAuthEvent::EVENT_AUTHENTICATION_POST (即 "认证.post")

此事件在 MvcEvent::EVENT_ROUTE 时触发,优先级为 499。它通过 Laminas\ApiTools\MvcAuth\MvcRouteListener 事件监听器聚合注册。

Laminas\ApiTools\MvcAuth\MvcAuthEvent::EVENT_AUTHORIZATION (即 "授权")

此事件在 MvcEvent::EVENT_ROUTE 时触发,优先级为 -600。它通过 Laminas\ApiTools\MvcAuth\MvcRouteListener 事件监听器聚合注册。

Laminas\ApiTools\MvcAuth\MvcAuthEvent::EVENT_AUTHORIZATION_POST (即 "授权.post")

此事件在 MvcEvent::EVENT_ROUTE 时触发,优先级为 -601。它通过 Laminas\ApiTools\MvcAuth\MvcRouteListener 事件监听器聚合注册。

Laminas\ApiTools\MvcAuth\MvcAuthEvent 对象

MvcAuthEvent 对象在任何认证或授权事件触发时提供上下文信息。它持续以下信息

  • 身份:setIdentity()getIdentity()
  • 认证服务:setAuthentication()getAuthentication()
  • 授权服务:setAuthorization()getAuthorization()
  • 授权结果:setIsAuthorizedisAuthorized()
  • 原始 MVC 事件:getMvcEvent()

监听器

Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationListener

此监听器连接到 MvcAuth::EVENT_AUTHENTICATION 事件。它主要负责执行任何身份验证,并确保已验证的身份在 MvcAuthEventMvcEvent 对象中持久化(后者在事件参数 Laminas\ApiTools\MvcAuth\Identity 下)。

Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationPostListener

此监听器连接到 MvcAuth::EVENT_AUTHENTICATION_POST 事件。它主要负责确定是否进行了失败的认证,如果是,则会在 MvcEvent 的响应对象上尝试设置 401 未授权 状态。

Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationListener

此监听器连接到 MvcAuth::EVENT_AUTHORIZATION 事件。它主要负责在配置的授权服务上执行 isAuthorized() 方法。

Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationPostListener

此监听器连接到 MvcAuth::EVENT_AUTHORIZATION_POST 事件。它主要负责确定当前请求是否已授权。在当前请求未被授权的情况下,它将尝试在 MvcEvent 的响应对象上设置 403 禁止 状态。

Laminas\ApiTools\MvcAuth\Authorization\DefaultResourceResolverListener

此监听器以 -1 的优先级连接到 MvcAuth::EVENT_AUTHENTICATION_POST。它主要负责在配合 api-tools-rest 模块使用时,为基于 api-tools-rest 的控制器创建并持久化一个特殊名称到当前事件中。

Laminas 服务

控制器插件

此模块公开了控制器插件 getIdentity(),映射到 Laminas\ApiTools\MvcAuth\Identity\IdentityPlugin。此插件将返回在身份验证过程中发现的身份,并将其注入到 Laminas\Mvc\MvcEventLaminas\ApiTools\MvcAuth\Identity 参数中。如果 MvcEvent 中不存在身份,或者存在的身份不是 Laminas\ApiTools\MvcAuth\Identity\IdentityInterface 的实例,则返回 Laminas\ApiTools\MvcAuth\Identity\GuestIdentity 的实例。

事件监听器服务

以下服务被提供,并作为事件监听器使用

  • Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationListener
  • Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationPostListener
  • Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationListener
  • Laminas\ApiTools\MvcAuth\Authorization\DefaultAuthorizationPostListener
  • Laminas\ApiTools\MvcAuth\Authorization\DefaultResourceResolverListener

Laminas\ApiTools\MvcAuth\Authentication (即 "认证")

这是一个 Laminas\Authentication\AuthenticationService 的实例。

Laminas\ApiTools\MvcAuth\Authentication\AuthHttpAdapter

这是一个 Laminas\Authentication\Adapter\Http 的实例。

Laminas\ApiTools\MvcAuth\Authorization\AclAuthorization (即 "授权",Laminas\ApiTools\MvcAuth\Authorization\AuthorizationInterface)

这是一个 Laminas\ApiTools\MvcAuth\Authorization\AclAuthorization 的实例,它是 Laminas\Permissions\Acl\Acl 的扩展。

Laminas\ApiTools\MvcAuth\ApacheResolver

这是一个 Laminas\Authentication\Adapter\Http\ApacheResolver 的实例。您可以通过提供自定义工厂来覆盖 ApacheResolver。

Laminas\ApiTools\MvcAuth\FileResolver

这是一个 Laminas\Authentication\Adapter\Http\FileResolver 的实例。您可以通过提供自定义工厂来覆盖 FileResolver。

认证适配器

  • 自 1.1.0 版起

认证适配器为向您的 API 中添加自定义认证功能提供了最直接的方式。适配器实现 Laminas\ApiTools\MvcAuth\Authentication\AdapterInterface

namespace Laminas\ApiTools\MvcAuth\Authentication;

use Laminas\Http\Request;
use Laminas\Http\Response;
use Laminas\ApiTools\MvcAuth\Identity\IdentityInterface;
use Laminas\ApiTools\MvcAuth\MvcAuthEvent;

interface AdapterInterface
{
    /**
     * @return array Array of types this adapter can handle.
     */
    public function provides();

    /**
     * Attempt to match a requested authentication type
     * against what the adapter provides.
     *
     * @param string $type
     * @return bool
     */
    public function matches($type);

    /**
     * Attempt to retrieve the authentication type based on the request.
     *
     * Allows an adapter to have custom logic for detecting if a request
     * might be providing credentials it's interested in.
     *
     * @param Request $request
     * @return false|string
     */
    public function getTypeFromRequest(Request $request);

    /**
     * Perform pre-flight authentication operations.
     *
     * Use case would be for providing authentication challenge headers.
     *
     * @param Request $request
     * @param Response $response
     * @return void|Response
     */
    public function preAuth(Request $request, Response $response);

    /**
     * Attempt to authenticate the current request.
     *
     * @param Request $request
     * @param Response $response
     * @param MvcAuthEvent $mvcAuthEvent
     * @return false|IdentityInterface False on failure, IdentityInterface
     *     otherwise
     */
    public function authenticate(Request $request, Response $response, MvcAuthEvent $mvcAuthEvent);
}

方法 provides() 应返回一个字符串数组,每个字符串都是此适配器提供的认证 "类型";例如,提供的 Laminas\ApiTools\MvcAuth\Authentication\HttpAdapter 可以提供 basic 和/或 digest

方法 matches($type) 应测试给定的 $type 是否与适配器提供的相匹配,以确定它是否可以处理认证请求。通常,这可以通过 return in_array($type, $this->provides(), true); 完成

方法 getTypeFromRequest() 可以用来将传入的请求与它解析的认证类型相匹配(如果有的话)。示例可能包括解析 Authorization 标头或自定义标头,如 X-Api-Token

方法 preAuth() 可以用来提供客户端挑战;通常,这只会由包含的 HttpAdapter 使用。

最后,使用authenticate()方法尝试对传入的请求进行身份验证。应该返回一个布尔值false,表示身份验证失败,或者返回一个Laminas\ApiTools\MvcAuth\Identity\IdentityInterface实例;如果返回了后者,该身份将在请求期间使用。

适配器连接到DefaultAuthenticationListener。要连接自定义适配器,您需要执行以下操作之一

  • 通过配置定义命名HTTP和/或OAuth2适配器。
  • 在事件监听器期间,获取您的适配器和DefaultAuthenticationListener服务,并将您的适配器连接到后者。
  • DefaultAuthenticationListener创建一个DelegatorFactory,在返回监听器之前连接您的自定义适配器。

定义命名HTTP和/或OAuth2适配器

由于HTTP和OAuth2支持是内置的,因此api-tools-mvc-auth提供了一种配置驱动的创建这些类型命名适配器的方法。每个都需要在api-tools-mvc-auth.authentication.adapters配置下的唯一键,每种类型都有自己的格式。

return [
    /* ... */
    'api-tools-mvc-auth' => [
        'authentication' => [
            'adapters' => [
                'api' => [
                    // This defines an HTTP adapter that can satisfy both
                    // basic and digest.
                    'adapter' => 'Laminas\ApiTools\MvcAuth\Authentication\HttpAdapter',
                    'options' => [
                        'accept_schemes' => ['basic', 'digest'],
                        'realm' => 'api',
                        'digest_domains' => 'https://example.com',
                        'nonce_timeout' => 3600,
                        'htpasswd' => 'data/htpasswd',
                        'htdigest' => 'data/htdigest',
                    ],
                ],
                'user' => [
                    // This defines an OAuth2 adapter backed by PDO.
                    'adapter' => 'Laminas\ApiTools\MvcAuth\Authentication\OAuth2Adapter',
                    'storage' => [
                        'adapter' => 'pdo',
                        'dsn' => 'mysql:host=localhost;dbname=oauth2',
                        'username' => 'username',
                        'password' => 'password',
                        'options' => [
                            1002 => 'SET NAMES utf8', // PDO::MYSQL_ATTR_INIT_COMMAND
                        ],
                    ],
                ],
                'client' => [
                    // This defines an OAuth2 adapter backed by Mongo.
                    'adapter' => 'Laminas\ApiTools\MvcAuth\Authentication\OAuth2Adapter',
                    'storage' => [
                        'adapter' => 'mongo',
                        'locator_name' => 'SomeServiceName', // If provided, pulls the given service
                        'dsn' => 'mongodb://localhost',
                        'database' => 'oauth2',
                        'options' => [
                            'username' => 'username',
                            'password' => 'password',
                            'connectTimeoutMS' => 500,
                        ],
                    ],
                ],
            ],
            /* ... */
        ],
        /* ... */
    ],
    /* ... */
];

上述配置将为您的应用程序提供身份验证类型['api-basic', 'api-digest', 'user', 'client'],每个都可以在身份验证类型映射中关联。

如果您使用api-tools-admin的Admin API和/或Laminas API Tools UI来配置身份验证适配器,将为您创建上述配置。

在事件监听器期间连接适配器

在这种情况下,最佳的事件是“身份验证”事件。在这样做的时候,您希望连接的优先级> 1,以确保它在DefaultAuthenticationListener之前执行。

在下面的示例中,我们假设您已定义一个名为MyCustomAuthenticationAdapter的服务,该服务返回一个AdapterInterface实现,并且该类是您的API的Module类或您的应用程序中的一个模块。

class Module
{
    public function onBootstrap($e)
    {
        $app      = $e->getApplication();
        $events   = $app->getEventManager();
        $services = $app->getServiceManager();

        $events->attach(
            'authentication',
            function ($e) use ($services) {
                $listener = $services->get('Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationListener')
                $adapter = $services->get('MyCustomAuthenticationAdapter');
                $listener->attach($adapter);
            },
            1000
        );
    }
}

通过返回空值,DefaultAuthenticationListener将继续执行,但现在也将连接到新的适配器。

使用委托工厂

委托工厂是一种“装饰”Laminas框架ServiceManager返回的实例的方法,以便提供先决条件或更改通常返回的实例。在我们的情况下,我们希望在实例创建后但在返回之前连接适配器。

在下面的示例中,我们假设您已定义一个名为MyCustomAuthenticationAdapter的服务,该服务返回一个AdapterInterface实现。下面是DefaultAuthenticationListener的委托工厂,它将注入我们的适配器。

use Laminas\ServiceManager\DelegatorFactoryInterface;
use Laminas\ServiceManager\ServiceLocatorInterface;

class CustomAuthenticationDelegatorFactory implements DelegatorFactoryInterface
{
    public function createDelegatorWithName(
        ServiceLocatorInterface $services,
        $name,
        $requestedName,
        $callback
    ) {
        $listener  = $callback();
        $listener->attach($services->get('MyCustomAuthenticationAdapter');
        return $listener;
    }
}

然后我们需要告诉ServiceManager有关委托工厂;我们在模块的config/module.config.phpconfig/autoload/配置文件之一中这样做。

return [
    /* ... */
    'service_manager' => [
        /* ... */
        'delegators' => [
            'Laminas\ApiTools\MvcAuth\Authentication\DefaultAuthenticationListener' => [
                'CustomAuthenticationDelegatorFactory',
            ],
        ],
    ],
    /* ... */
];

一旦配置完成,我们的适配器将连接到获取的每个DefaultAuthenticationListener实例。