Update documentation for clarity and consistency
All checks were successful
Build and Deploy Hugo / Deploy Hugo Website (pull_request) Successful in 24s

Remove emojis and em dash separators
Simplify introductory sentences
Standardize section headings
This commit is contained in:
Damien
2026-07-19 15:09:56 +02:00
parent 0edec585a7
commit 2d8830960b
22 changed files with 485 additions and 553 deletions

View File

@@ -6,45 +6,38 @@ cascade:
type: docs
---
## 🔗 Sources
## Sources
- [📖 Official Documentation](https://smallstep.com/docs/tutorials/)
- [🛠️ Step-CA as a systemd Service](https://angrysysadmins.tech/index.php/2022/09/grassyloki/step-ca-run-as-a-systemd-service/)
- [🔐 Certificate Management with OpenSSL](https://www.golinuxcloud.com/tutorial-pki-certificates-authority-ocsp/)
- [Official documentation](https://smallstep.com/docs/tutorials/)
- [Step-CA as a systemd service](https://angrysysadmins.tech/index.php/2022/09/grassyloki/step-ca-run-as-a-systemd-service/)
- [Certificate management with OpenSSL](https://www.golinuxcloud.com/tutorial-pki-certificates-authority-ocsp/)
## 🤖 About Step-CA
## About Step-CA
Step-CA is a clever toolset developed by Smallstep, a company specializing in secure identity management and certificate automation. 🚀
Its mission? To simplify setting up and managing your own certificate authorities (CAs) with ease and security!
Step-CA is a toolset developed by Smallstep, a company specializing in secure identity management and certificate automation.
Its mission is to simplify setting up and managing your own certificate authorities (CAs).
### Key Features
### Key features
1. **Certificate Authority Management** 🔑
Easily configure and manage your own CAs. Create root and intermediate CAs, issue certificates, and handle revocations like a pro.
1. Certificate authority management: easily configure and manage your own CAs. Create root and intermediate CAs, issue certificates, and handle revocations.
2. **Secure Key Management** 🛡️
Follows best practices for securely storing and managing keys, ensuring your cryptographic keys stay protected from unauthorized access.
2. Secure key management: follows best practices for securely storing and managing keys, so your cryptographic keys stay protected from unauthorized access.
3. **Automation and Scalability** ⚙️
Ideal for small to large-scale deployments. Take advantage of APIs and integrations that automate certificate issuance, renewal, and revocation for a smooth lifecycle.
3. Automation and scalability: works for small to large-scale deployments. APIs and integrations automate certificate issuance, renewal, and revocation across the lifecycle.
4. **Enhanced Security** 🔒
Through the use of modern cryptographic algorithms and protocols, Step-CA supports industry-standard X.509 certificates, providing robust encryption and digital signatures.
4. Modern cryptography: Step-CA supports industry-standard X.509 certificates using modern cryptographic algorithms and protocols for encryption and digital signatures.
5. **Infrastructure Integration** 🌐
Integrates seamlessly with your existing tools and systems. Supports various authentication methods such as username/password, MFA, and external identity providers.
5. Infrastructure integration: integrates with your existing tools and systems, and supports various authentication methods such as username/password, MFA, and external identity providers.
6. **Auditability and Compliance** 📜
With comprehensive logging and auditing capabilities, you can track certificate activity and meet compliance requirements with ease.
6. Auditability and compliance: comprehensive logging and auditing let you track certificate activity and meet compliance requirements.
7. **Developer-Friendly APIs** 👩‍💻👨‍💻
APIs and SDKs designed for developers make it easy to integrate certificate management into your applications and custom workflows.
7. Developer-friendly APIs: APIs and SDKs designed for developers make it easy to integrate certificate management into your applications and custom workflows.
**In short:** Step-CA by Smallstep is designed to make certificate authority management both fun and hassle-free. Thanks to its secure, scalable, and user-friendly features, you can easily manage your certificates' lifecycle while protecting your infrastructure!
Step-CA by Smallstep is built to make certificate authority management straightforward: you manage your certificates' lifecycle while keeping your infrastructure protected.
## 🚀 Installation
## Installation
### 🔧 Binary Installation
### Binary installation
#### 1. Step CLI
@@ -60,7 +53,7 @@ wget https://dl.step.sm/gh-release/certificates/docs-ca-install/v0.24.1/step-ca_
sudo dpkg -i step-ca_0.24.1_amd64.deb
```
#### 3. Creating a Dedicated User
#### 3. Creating a dedicated user
```bash
adduser adminCA
@@ -81,8 +74,8 @@ What would you like to name the CA's first provisioner?
Choose a password for your CA keys and the first provisioner.
[leave empty and we will generate one] :
Generating root certificate... done! 🎉
Generating intermediate certificate... done! 🎊
Generating root certificate... done!
Generating intermediate certificate... done!
✔ Root certificate: /home/adminCA/.step/certs/root_ca.crt
✔ Root private key: /home/adminCA/.step/secrets/root_ca_key
@@ -95,7 +88,7 @@ Generating intermediate certificate... done! 🎊
Your PKI is ready to go. To generate certificates for individual services, see `step help ca`.
💌 **FEEDBACK**
**Feedback:**
The step utility is not instrumented for usage statistics. It does not contact a central server. Your feedback is, however, extremely valuable! Please consider writing to feedback@smallstep.com, joining GitHub Discussions, or joining us on Discord at [https://u.step.sm/discord](https://u.step.sm/discord).
```
@@ -111,10 +104,10 @@ step-ca .step/config/ca.json
$ step ca provisioner add acme --type ACME
✔ CA Configuration: /home/adminCA/.step/config/ca.json
Success! Your `step-ca` configuration has been updated. To pick up the new configuration, send a SIGHUP (kill -1 <pid>) or restart the step-ca process. 🎉
Success! Your `step-ca` configuration has been updated. To pick up the new configuration, send a SIGHUP (kill -1 <pid>) or restart the step-ca process.
```
#### Running Step-CA as a systemd Service
#### Running Step-CA as a systemd service
Create a file:
@@ -155,7 +148,7 @@ systemctl daemon-reload
systemctl start step-ca.service
```
### 🐳 Docker Installation
### Docker installation
```bash
docker run -it -v step:/home/step \
@@ -167,11 +160,11 @@ docker run -it -v step:/home/step \
smallstep/step-ca
```
## 🔑 Accessing the CA from Another Client
## Accessing the CA from another client
> [!NOTE] Adjust the port based on your installation:
> [!NOTE] Adjust the port based on your installation:
>
> - **Binary:** port **443**
> - **Binary:** port **443**
> - **Docker:** port **9000**
Install the Step CLI:
@@ -226,7 +219,7 @@ step certificate install $(step path)/certs/root_ca.crt
---
### 📝 Obtaining a Certificate
### Obtaining a certificate
```bash
admin@User:~$ step ca certificate nas.lab.loc srv.crt srv.key

View File

@@ -6,45 +6,38 @@ cascade:
type: docs
---
## 🔗 Sources
## Sources
- [📖 Documentation Officielle](https://smallstep.com/docs/tutorials/)
- [🛠️ Step-CA en tant que Service systemd](https://angrysysadmins.tech/index.php/2022/09/grassyloki/step-ca-run-as-a-systemd-service/)
- [🔐 Gestion des Certificats avec OpenSSL](https://www.golinuxcloud.com/tutorial-pki-certificates-authority-ocsp/)
- [Documentation officielle](https://smallstep.com/docs/tutorials/)
- [Step-CA en tant que service systemd](https://angrysysadmins.tech/index.php/2022/09/grassyloki/step-ca-run-as-a-systemd-service/)
- [Gestion des certificats avec OpenSSL](https://www.golinuxcloud.com/tutorial-pki-certificates-authority-ocsp/)
## 🤖 À propos de Step-CA
## À propos de Step-CA
Step-CA est un ensemble d'outils astucieux développé par Smallstep, une entreprise spécialisée dans la gestion sécurisée des identités et l'automatisation des certificats. 🚀
Sa mission ? Simplifier la mise en place et la gestion de vos propres autorités de certification (AC) avec facilité et sécurité !
Step-CA est un ensemble d'outils développé par Smallstep, une entreprise spécialisée dans la gestion sécurisée des identités et l'automatisation des certificats.
Sa mission est de simplifier la mise en place et la gestion de vos propres autorités de certification (AC).
### Principales fonctionnalités
1. **Gestion des Autorités de Certification** 🔑
Configurez et gérez facilement vos propres AC. Créez des AC racines et intermédiaires, délivrez des certificats et gérez les révocations comme un pro.
1. Gestion des autorités de certification : configurez et gérez facilement vos propres AC. Créez des AC racines et intermédiaires, délivrez des certificats et gérez les révocations.
2. **Gestion Sécurisée des Clés** 🛡️
Respecte les bonnes pratiques pour le stockage et la gestion sécurisés des clés, garantissant que vos clés cryptographiques restent protégées contre les accès non autorisés.
2. Gestion sécurisée des clés : respecte les bonnes pratiques pour le stockage et la gestion des clés, afin que vos clés cryptographiques restent protégées contre les accès non autorisés.
3. **Automatisation et Scalabilité** ⚙️
Idéal pour les déploiements de petite à grande envergure. Profitez des API et intégrations qui automatisent la délivrance, le renouvellement et la révocation des certificats pour un cycle de vie sans accrocs.
3. Automatisation et scalabilité : adapté aux déploiements de petite à grande envergure. Les API et intégrations automatisent la délivrance, le renouvellement et la révocation des certificats tout au long du cycle de vie.
4. **Sécurité Renforcée** 🔒
Grâce à l'utilisation d'algorithmes et de protocoles cryptographiques modernes, Step-CA prend en charge les certificats X.509 conformes aux normes de l'industrie, offrant un chiffrement robuste et des signatures numériques.
4. Cryptographie moderne : Step-CA prend en charge les certificats X.509 conformes aux normes de l'industrie, avec des algorithmes et protocoles cryptographiques modernes pour le chiffrement et les signatures numériques.
5. **Intégration avec l'Infrastructure** 🌐
S'intègre parfaitement avec vos outils et systèmes existants. Prend en charge diverses méthodes d'authentification telles que nom d'utilisateur/mot de passe, MFA et fournisseurs d'identité externes.
5. Intégration avec l'infrastructure : s'intègre avec vos outils et systèmes existants, et prend en charge diverses méthodes d'authentification telles que nom d'utilisateur/mot de passe, MFA et fournisseurs d'identité externes.
6. **Auditabilité et Conformité** 📜
Avec des capacités complètes de journalisation et d'audit, vous pouvez suivre les activités des certificats et satisfaire aux exigences de conformité en toute simplicité.
6. Auditabilité et conformité : la journalisation et l'audit complets permettent de suivre les activités des certificats et de répondre aux exigences de conformité.
7. **API Conviviales pour les Développeurs** 👩‍💻👨‍💻
Des API et SDK conçus pour les développeurs facilitent l'intégration de la gestion des certificats dans vos applications et flux de travail personnalisés.
7. API conviviales pour les développeurs : des API et SDK conçus pour les développeurs facilitent l'intégration de la gestion des certificats dans vos applications et flux de travail personnalisés.
**En résumé :** Step-CA de Smallstep est conçu pour rendre la gestion des autorités de certification à la fois ludique et sans tracas. Grâce à ses fonctionnalités sécurisées, scalables et conviviales, vous pouvez gérer facilement le cycle de vie de vos certificats tout en protégeant votre infrastructure !
Step-CA de Smallstep est conçu pour rendre la gestion des autorités de certification simple : vous gérez le cycle de vie de vos certificats tout en protégeant votre infrastructure.
## 🚀 Installation
## Installation
### 🔧 Installation Binaire
### Installation binaire
#### 1. Step CLI
@@ -60,7 +53,7 @@ wget https://dl.step.sm/gh-release/certificates/docs-ca-install/v0.24.1/step-ca_
sudo dpkg -i step-ca_0.24.1_amd64.deb
```
#### 3. Création d'un Utilisateur Spécifique
#### 3. Création d'un utilisateur dédié
```bash
adduser adminCA
@@ -81,8 +74,8 @@ Quel nom souhaitez-vous donner au premier provisionneur de l'AC ?
Choisissez un mot de passe pour vos clés AC et le premier provisionneur.
✔ [laissez vide et nous en générerons un] :
Génération du certificat racine... fait ! 🎉
Génération du certificat intermédiaire... fait ! 🎊
Génération du certificat racine... fait !
Génération du certificat intermédiaire... fait !
✔ Certificat racine : /home/adminCA/.step/certs/root_ca.crt
✔ Clé privée racine : /home/adminCA/.step/secrets/root_ca_key
@@ -95,7 +88,7 @@ Génération du certificat intermédiaire... fait ! 🎊
Votre PKI est prête ! Pour générer des certificats pour des services individuels, consultez `step help ca`.
💌 **RETROACTION**
**Retours :**
L'utilitaire step n'est pas instrumenté pour les statistiques d'utilisation. Il ne contacte pas un serveur central. Toutefois, vos retours sont très précieux ! N'hésitez pas à nous écrire à feedback@smallstep.com, rejoindre les Discussions GitHub ou nous rejoindre sur Discord à [https://u.step.sm/discord](https://u.step.sm/discord).
```
@@ -111,10 +104,10 @@ step-ca .step/config/ca.json
$ step ca provisioner add acme --type ACME
✔ Configuration de l'AC : /home/adminCA/.step/config/ca.json
Succès ! La configuration de votre `step-ca` a été mise à jour. Pour prendre en compte la nouvelle configuration, envoyez un SIGHUP (kill -1 <pid>) ou redémarrez le processus step-ca. 🎉
Succès ! La configuration de votre `step-ca` a été mise à jour. Pour prendre en compte la nouvelle configuration, envoyez un SIGHUP (kill -1 <pid>) ou redémarrez le processus step-ca.
```
#### Exécuter Step-CA en tant que Service systemd
#### Exécuter Step-CA en tant que service systemd
Créez un fichier :
@@ -155,7 +148,7 @@ systemctl daemon-reload
systemctl start step-ca.service
```
### 🐳 Installation avec Docker
### Installation avec Docker
```bash
docker run -it -v step:/home/step \
@@ -167,11 +160,11 @@ docker run -it -v step:/home/step \
smallstep/step-ca
```
## 🔑 Accès à l'AC avec un Autre Client
## Accès à l'AC avec un autre client
> [!NOTE] Adaptez le port en fonction de votre installation :
> [!NOTE] Adaptez le port en fonction de votre installation :
>
> - **Binaire :** port **443**
> - **Binaire :** port **443**
> - **Docker :** port **9000**
Installez le Step CLI :
@@ -226,7 +219,7 @@ step certificate install $(step path)/certs/root_ca.crt
---
### 📝 Obtenir un Certificat
### Obtenir un certificat
```bash
admin@User:~$ step ca certificate nas.lab.loc srv.crt srv.key