Commit be076acb authored by Stephane Bouvry's avatar Stephane Bouvry
Browse files

Installation des commandes

Doc (début)
parent f63d9a41
Loading
Loading
Loading
Loading
Loading
+39 −71
Changes for README.md: 39 added lines, 71 removed lines.
Original line number Diff line number Diff line
@@ -2,91 +2,59 @@



## Getting started
## Présentation

To make it easy for you to get started with GitLab, here's a list of recommended next steps.
**Unicaen Signature** est un module permettant de gérer l'accès à un *parapheur numérique*.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
### Fonctionnalités base
 - Modèle de gestion des signatures envoyées
 - Uniformisation des échanges avec un parapheur

## Add your files
### Processus de validation
 - Configuration de processus de validation de document (étapes)
 - Interface d'administration

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
### Parapheurs pris en charge
 - Esup
 - ...

```
cd existing_repo
git remote add origin https://git.unicaen.fr/lib/unicaen/signature.git
git branch -M master
git push -uf origin master
```

## Integrate with your tools

- [ ] [Set up project integrations](https://git.unicaen.fr/lib/unicaen/signature/-/settings/integrations)

## Collaborate with your team

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

## Test and Deploy

Use the built-in continuous integration in GitLab.

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
## Installation dans votre application

***
### Prérequis

# Editing this README
 - PHP 8.2

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
### Dépendance PHP

## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Ajouter l'adresse du dépôt Unicaen si besoin dans le composer JSON : 

## Name
Choose a self-explaining name for your project.

## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
```json
{
  "repositories": [
    {
      "type": "composer",
      "url": "https://gest.unicaen.fr/packagist"
    }
  ],
  "name": "VotreApplication",
  "Etc": "..."
}
```

## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
Puis ajouter la dépendance

## Contributing
State if you are open to contributions and what your requirements are for accepting them.
```bash
require 'unicaen/signature'
```

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
Copier la configuration par défaut : 

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
```bash
cp vendor/unicaen/signature/conf/unicaen-signature.php.dist config/autoload/signature.local.php
```

## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
Puis configurez le parapheur : 

## License
For open source projects, say how it is licensed.
 - **Esup** : [Configuration du parapheur ESUP](./doc/config/config-parapheur-esup.md)

## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
> Vous pouvez configurer plusieurs parapheurs
 No newline at end of file

bin/unicaen-signature

0 → 100644
+4 −0
Changes for bin/unicaen-signature: 4 added lines, 0 removed lines.
Original line number Diff line number Diff line
#!/usr/bin/env php
<?php

include(__DIR__ . '/doctrine-module.php');
 No newline at end of file
+84 −0
Changes for bin/unicaen-signature.php: 84 added lines, 0 removed lines.
Original line number Diff line number Diff line
<?php

use Laminas\Mvc\Application;
use Laminas\Stdlib\ArrayUtils;

ini_set('display_errors', true);
chdir(__DIR__);

$previousDir = '.';

while (!file_exists('config/application.config.php')) {
    $dir = dirname(getcwd());

    if ($previousDir === $dir) {
        throw new RuntimeException(
            'Unable to locate "config/application.config.php": ' .
            'is DoctrineModule in a subdir of your application skeleton?'
        );
    }

    $previousDir = $dir;
    chdir($dir);
}


if (is_readable('init_autoloader.php')) {
    include_once 'init_autoloader.php';
} elseif (file_exists(__DIR__ . '/../vendor/autoload.php')) {
    include_once __DIR__ . '/../vendor/autoload.php';
} elseif (file_exists(__DIR__ . '/../../../autoload.php')) {
    include_once __DIR__ . '/../../../autoload.php';
} else {
    throw new RuntimeException('Error: vendor/autoload.php could not be found. Did you run php composer.phar install?');
}

$appConfig = include 'config/application.config.php';
if (file_exists('config/development.config.php')) {
    $appConfig = ArrayUtils::merge($appConfig, include 'config/development.config.php');
}

$app = Application::init($appConfig);

$commands = [];

$paths = $app->getConfig()['console_commands'];

function scanCommandFiles(string $namespace, string $dir){
    global $app;
    $output = [];
    $re = '/.*Command\.php/m';

    if( !file_exists($dir) ){
        echo ("[WARNING] Command path : Le dossier '$dir' n'existe pas\n");
        return [];
    }

    $scan = scandir($dir);
    foreach ($scan as $key => $value) {
        if( !in_array($value, ['.', '..']) ){
            if( is_dir($dir.DIRECTORY_SEPARATOR.$value) ){

            } else {
                if( preg_match($re, $value, $matches) ){
                    $class = substr($value, 0, strlen($value)-4);
                    $reflector = new ReflectionClass($namespace.$class);
                    if( $reflector->isSubclassOf(\Symfony\Component\Console\Command\Command::class) ){
                        $instance = $reflector->newInstanceArgs([$app->getServiceManager()]);
                        if( property_exists($instance, 'disabled') ) {
                            continue;
                        }
                        $result[] = $instance;
                    }
                }
            }
        }
    }
    return $result;
}

foreach ($paths as $namespace=>$path) {
    $commands = scanCommandFiles($namespace, $path);
    $console->addCommands($commands);
}
exit($console->run());
 No newline at end of file
+3 −0
Changes for composer.json: 3 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -7,6 +7,9 @@
      "url": "https://gest.unicaen.fr/packagist"
    }
  ],
  "bin": [
    "unicaen-signature"
  ],
  "require": {
  },
  "autoload": {
+48 −0
Changes for doc/config/config-parapheur-esup.md: 48 added lines, 0 removed lines.
Original line number Diff line number Diff line
# Configurer le parapheur ESUP

## Autoriser l'IP de votre application dans Esup

> L'accès à l'API REST de **Esup** necessite d'autoriser l'accès à l'IP de votre application.
> 
> Fichier dans Esup `install/path/conf`
> 
> Relancer Esup pour prendre en compte la configuration

## Configuration

```php
<?php
// config/autoload/signature.local.php
return [
    'unicaen-signature' => [
        // Parapheurs
        'letterfiles' => [
            // ----------------------------------- ESUP
            [
                'label'     => 'ESUP', // Nom visible
                'name'      => 'esup', // Unique
                'description' => 'Parafeur numérique ESUP',
                'default'   => true, // Parpheur par défaut
                'class'     => \UnicaenSignature\Strategy\Letterfile\Esup\EsupLetterfileStrategy::class,

                // Niveaux de signature disponible
                'levels'    => [
                    \UnicaenSignature\Utils\SignatureConstants::VISA_HIDDEN => 'hidden',
                    \UnicaenSignature\Utils\SignatureConstants::VISA_VISUAL => 'visa',
                    \UnicaenSignature\Utils\SignatureConstants::SIGN_VISUAL => 'pdfImageStamp',
                    \UnicaenSignature\Utils\SignatureConstants::SIGN_CERTIF => 'certSign',
                    \UnicaenSignature\Utils\SignatureConstants::SIGN_EIDAS => 'nexuSign',
                ],

                // Accès à ESUP
                'config'    => [
                    // URL de l'API Esup
                    'url' => "https://esup.votredomaine.ext",
                    // Créateur
                    'createdByEppn' => 'eppn@votredomaine.ext',
                ]
            ]
        ]
    ]
];
```
Loading