Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/os2web/os2web_key
https://github.com/os2web/os2web_key
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/os2web/os2web_key
- Owner: OS2web
- Created: 2024-04-26T08:42:59.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-17T13:13:24.000Z (7 months ago)
- Last Synced: 2024-11-11T22:52:34.185Z (about 2 months ago)
- Language: PHP
- Size: 400 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# OS2Web key
Key types and providers for OS2Web built on the [Key module](https://www.drupal.org/project/key).
The OS2Web key module provides two _key types_, [Certificate](#certificate) and [OpenID Connect
(OIDC)](#openid-connect-oidc). Two _key providers_, [Azure Key Vault](#azure-key-vault) and [Infisical](#infisical), are
planned, but not yet implemented.
See [the Key Developer Guide](https://www.drupal.org/docs/contributed-modules/key/developer-guide) for details in how to
use keys in Drupal.
## Installation
``` shell
composer require os2web/os2web_key
drush pm:install os2web_key
```
Keys are managed on `/admin/config/system/keys`.
## Key types
### Certificate
This key type handles [PKCS 12](https://en.wikipedia.org/wiki/PKCS_12) or [Privacy-Enhanced Mail
(PEM)](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) certificate with an optional password (passphrase).
Managing the key:
Use in a form:
``` php
$form['key'] => [
'#type' => 'key_select',
'#key_filters' => [
'type' => 'os2web_key_certificate',
],
];
```
The [`KeyHelper`](https://github.com/OS2web/os2web_key/blob/main/src/KeyHelper.php) can be used to get
the actual certificates (parts):
``` php
getKey('my_key');
[
// Passwordless certificate.
CertificateKeyType::CERT => $certificate,
CertificateKeyType::PKEY => $privateKey,
] = $helper->getCertificates($key);
```
**Note**: The parsed certificate has no password.
### OpenID Connect (OIDC)
Managing the key:
Example use in a form:
``` php
$form['key'] => [
'#type' => 'key_select',
'#key_filters' => [
'type' => 'os2web_key_oidc,
],
];
```
Get the OIDC config:
``` php
getKey('openid_connect_ad');
[
OidcKeyType::DISCOVERY_URL => $discoveryUrl,
OidcKeyType::CLIENT_ID => $clientId,
OidcKeyType::CLIENT_SECRET => $clientSecret,
] = $helper->getOidcValues($key);
```
## Providers
### Azure Key Vault
`@todo`
### Infisical
`@todo`
## Coding standards
Our coding are checked by GitHub Actions (cf. [.github/workflows/pr.yml](.github/workflows/pr.yml)). Use the commands
below to run the checks locally.
### PHP
```shell
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer install
# Fix (some) coding standards issues
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-apply
# Check that code adheres to the coding standards
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-check
```
### Markdown
```shell
docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md' --fix
docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md'
```
## Code analysis
We use [PHPStan](https://phpstan.org/) for static code analysis.
Running statis code analysis on a standalone Drupal module is a bit tricky, so we use a helper script to run the
analysis:
```shell
docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm ./scripts/code-analysis
```