README

本模块将 ReadID Ready App 添加为 simpleSAMLphp 的身份验证源。ReadID Ready 是一款可以从您的护照或其他身份证明文件中读取数据的应用程序。除了从文件芯片中收集您的个人信息外，它还会验证您的身份证明文件是否有效和真实。通过使用此模块，您可以使用身份证、护照或驾驶执照进行身份验证。

免责声明

此模块不是由 ReadID 或 InnoValor（创建 ReadID 的公司）创建的，它们也不会支持此模块。有关此模块的任何问题，请使用 github issues。使用此模块需要有效的 ReadID Ready 使用合同。有关 ReadID 的更多信息，请参阅 https://www.readid.com/

使用方法

SimpleSAMLphp 使用 Composer 来管理依赖项和第三方模块。只需执行以下命令

composer.phar require surf/simplesamlphp-module-readid

请注意，如果您没有对您的 Web 服务器的控制台访问权限，您需要将模块部署到其他地方，然后将文件复制到您的服务器上。

配置

将身份验证源添加到 authsource.php

$config = [
...
    'readid' => [
        'readid:ReadID',
        'apiCreateSession' => '/odata/v1/ODataServlet/createReadySession',
        'requesterApiKey' => <YOUR REQUESTER KEY>
        'iProov' => true,
        'scope' => '<YOUR ORGANISATIONAL SCOPE>',
        'timeout' => 180,
    ],
...

• apiCreateSession，您可能不需要更改此设置
• requesterApiKey，是请求会话的 ReadID 密钥
• iProov，在 ReadID 过程中启用或禁用 iProov
• scope，添加到范围属性的范围内。您可以在 lib/Auth/Source/ReadID.php::getUser() 中调整（SAML）属性映射
• timeout，在显示超时消息之前，用户有多少时间完成其文件的读取

身份验证源还需要一个特定的 readid 配置 config-readid.conf 在配置目录中

<?php
$config = [
    'dbFile' => '<YOUR SQLITE DB LOCATION>',
    'apiBaseUrl' => 'https://<the readid endpoint base>',
    'apiReadSession' => '/odata/v1/ODataServlet/Sessions',
    'viewerApiKey' => <YOUR VIEWER KEY>,
    'callbackUser' => <ReadID callback username>,
    'callbackPassword' => <ReadID callback password>,
];

• dbfile 包含临时会话数据库的位置。这是一个 sqlite 文件，需要由 Web 服务器用户可写。
• apiBaseUrl 是您想要使用的 ReadID 基础 URL（不带尾随斜杠），请参阅 ReadID 文档
• apiReadSession，您可能不需要更改此设置
• viewerApiKey 是可以查看会话的 ReadID 密钥
• callbackUser 和 callbackPassword 是您在 ReadID 中配置的用户/密码，以便它们可以调用我们的已认证回调端点