cesnet/simplesamlphp-module-perunauthorize

用于与Perun模块一起工作的SimpleSAMLPHP授权模块

v2.1.1 2024-03-08 16:21 UTC

README

maintenance status: end of life

该项目已达到生命周期的结束,这意味着不会添加新功能。安全补丁和重要的错误修复将在2023年结束。请查看 SATOSAPerun AAI的微服务

描述

Latest Stable Version Latest Unstable Version CodeFactor License

此模块是SSP模块授权的修改版。不同之处在于可以在未经授权的消息中添加占位符,这些占位符将用请求中的实际值替换。有关详细文档,请参阅以下内容。

安装

php composer.phar require cesnet/simplesamlphp-module-perunauthorize

Perunauthorize过程过滤器

Perunauthorize是基于属性匹配的用户授权过滤器。未经授权的用户将被显示403禁止页面。以下列出了配置选项。

  • deny(默认 false):当设置为 false 时,如果找到属性匹配,则用户被授权。当设置为 true 时,除非找到属性匹配,否则用户被授权。

  • regex(默认 true):为定义的属性值打开或关闭正则表达式模式匹配。

  • message(默认 null):如果设置,则未经授权的用户将被发送到包含自定义文本的未经授权页面。此选项的值必须是包含消息翻译到支持的语言的字典。然后显示用户的支持翻译。此消息还可以包含 %SERVICE_NAME%%SERVICE_EMAIL% 作为占位符。%SERVICE_NAME% 然后用服务名替换。 %SERVICE_EMAIL% 用在 'administrationContact' 选项中指定的属性值替换(见下文)。

    • 示例
    'message' => [
      'en' => 'Example message with a service name: %SERVICE_NAME% and administration contact: %SERVICE_EMAIL%',
      'cs' => 'Příklad zprávy s názvem služby: %SERVICE_NAME% a kontaktem na administrátory: %SERVICE_EMAIL%',
    ]
    
  • administrationContact(默认 null):包含属性名称的字符串值。如果请求中找到此属性,则其值用于 message 而不是 %SERVICE_EMAIL% 占位符。如果 message 不包含此占位符,则没有设置此选项的理由。

  • 每个额外的过滤器配置选项都视为一个属性匹配规则。对于每个属性,您可以指定一个字符串或字符串数组进行匹配。如果这些属性中的任何一个与规则之一(或运算符)匹配,则用户被授权/未经授权(根据 deny 配置选项)。