Skip to content
This repository has been archived by the owner on Jun 24, 2022. It is now read-only.

Commit

Permalink
Fix markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
tvdijen committed Apr 5, 2022
1 parent 6a4062a commit 84dc61e
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 36 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,37 @@
# subject-identifier-attrs module

![Build Status](https://github.com/simplesamlphp/simplesamlphp-module-subjectidattrs/workflows/CI/badge.svg?branch=master)
[![Coverage Status](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-subjectidattrs/branch/master/graph/badge.svg)](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-subjectidattrs)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-subjectidattrs/badges/quality-score.png?branch=master)](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-subjectidattrs/?branch=master)
[![Type Coverage](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-subjectidattrs/coverage.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-subjectidattrs)
[![Psalm Level](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-subjectidattrs/level.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-subjectidattrs)

subject-identifier-attrs module
===============================

This module provides authproc-filters for releasing the attributes defined in the SAML V2.0 Subject Identifier Attributes Profile.
See https://docs.oasis-open.org/security/saml-subject-id-attr/v1.0/saml-subject-id-attr-v1.0.pdf
This module provides authproc-filters for releasing the attributes defined
in the [SAML V2.0 Subject Identifier Attributes Profile][specification].

Installation
------------
## Installation

Once you have installed SimpleSAMLphp, installing this module is very simple. Just execute the following
command in the root of your SimpleSAMLphp installation:
Once you have installed SimpleSAMLphp, installing this module is very simple.
Just execute the following command in the root of your SimpleSAMLphp
installation:

```
```bash
composer.phar require simplesamlphp/simplesamlphp-module-subjectidattrs:dev-master
```

where `dev-master` instructs Composer to install the `master` branch from the Git repository. See the
[releases](https://github.com/simplesamlphp/simplesamlphp-module-subjectidattrs/releases) available if you
want to use a stable version of the module.
where `dev-master` instructs Composer to install the `master` branch from the
Git repository. See the [releases][releases]
available if you want to use a stable version of the module.

Next thing you need to do is to enable the module: in
`config.php`, search for the `module.enable` key and set `subjectidattrs` to true:
Next thing you need to do is to enable the module: in `config.php`,
search for the `module.enable` key and set `subjectidattrs` to true:

```php
'module.enable' => [
'subjectidattrs' => true,
],
```

```php
'module.enable' => [
'subjectidattrs' => true,
],
```
[specification]: https://docs.oasis-open.org/security/saml-subject-id-attr/v1.0/saml-subject-id-attr-v1.0.pdf
[releases]: https://github.com/simplesamlphp/simplesamlphp-module-subjectidattrs/releases
17 changes: 11 additions & 6 deletions docs/authproc_pairwiseid.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
`subjectidattrs:PairwiseID`
===================

Filter to insert a pairwise-id that complies with the following specification;
http://docs.oasis-open.org/security/saml-subject-id-attr/v1.0/saml-subject-id-attr-v1.0.pdf
Filter to insert a pairwise-id that complies with the
[SAML V2.0 Subject Identifier Attributes Profile][specification].

This filter will take an attribute and a scope as input and transforms this into a anonymized and scoped
identifier that is globally unique for a given user & service provider combination.
[specification]: http://docs.oasis-open.org/security/saml-subject-id-attr/v1.0/saml-subject-id-attr-v1.0.pdf

This filter will take an attribute and a scope as input and transforms this
into a anonymized and scoped identifier that is globally unique for a given
user & service provider combination.

Note:
Since the subject-id is specified as single-value attribute, only the first value of `identifyingAttribute`
and `scopeAttribute` are considered.
Since the subject-id is specified as single-value attribute, only the first
value of `identifyingAttribute` and `scopeAttribute` are considered.

Examples
--------

```php
'authproc' => [
50 => [
'class' => 'subjectidattrs:PairwiseID',
'identifyingAttribute' => 'uid',
'scopeAttribute' => 'scope',
],
],
```
23 changes: 14 additions & 9 deletions docs/authproc_subjectid.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
`subjectidattrs:SubjectID`
===================

Filter to insert a subject-id that complies with the following specification;
http://docs.oasis-open.org/security/saml-subject-id-attr/v1.0/saml-subject-id-attr-v1.0.pdf
Filter to insert a subject-id that complies with the
[SAML V2.0 Subject Identifier Attributes Profile][specification].

This filter will take an attribute and a scope as input and transforms this into a scoped identifier that is globally unique for a given user.
[specification]: http://docs.oasis-open.org/security/saml-subject-id-attr/v1.0/saml-subject-id-attr-v1.0.pdf

Note:
-----
If privacy is of your concern, you may want to use the PairwiseID-filter instead.
This filter will take an attribute and a scope as input and transforms this
into a scoped identifier that is globally unique for a given user.

Note:
Since the subject-id is specified as single-value attribute, only the first value of `identifyingAttribute`
and `scopeAttribute` are considered.
**Note**
If privacy is of your concern, you may want to use the PairwiseID-filter
instead.

**Note**
Since the subject-id is specified as single-value attribute, only the first
value of `identifyingAttribute` and `scopeAttribute` are considered.

Examples
--------

```php
'authproc' => [
50 => [
'class' => 'subjectidattrs:SubjectID',
'identifyingAttribute' => 'uid',
'scopeAttribute' => 'scope',
],
],
```

0 comments on commit 84dc61e

Please sign in to comment.