https://github.com/keyfactor/ejbca-easy-rest-client
Erce – The Easy Rest Client for EJBCA
https://github.com/keyfactor/ejbca-easy-rest-client
Last synced: 9 months ago
JSON representation
Erce – The Easy Rest Client for EJBCA
- Host: GitHub
- URL: https://github.com/keyfactor/ejbca-easy-rest-client
- Owner: Keyfactor
- License: lgpl-2.1
- Created: 2022-05-18T12:26:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T15:13:44.000Z (9 months ago)
- Last Synced: 2025-05-05T16:28:05.055Z (9 months ago)
- Language: Java
- Size: 1.62 MB
- Stars: 17
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Erce – The Easy Rest Client for EJBCA
[](https://github.com/Keyfactor/ejbca-ce/discussions)
Erce is a fully FOSS REST Client for EJBCA. Its purpose is to act as a REST-based alternative to the EJBCA CLI and other enrollment protocols such as SCEP and CMP in environments where the UI is not available/optimal, but also to allow for further scripting by branching and extending this implementation. Erce is compatible with EJBCA 7.9.0.1 and later, though the latest released version is recommended for full endpoint support.
Erce contains support for both CE and EE endpoints, as well as a built in stress test to measure performance and throughput.
## Get started
Erce is a fully self-contained Gradle project. To build:
1. Check out a local branch
2. Build and package using Gradle
```
./gradlew build
```
3. Run the resulting .jar file with the --help flag to see the available commands.
```
java -jar build/erce-x.y.x.jar --help
```
An example command can looks like:
```
java -jar build/erce-1.0.0.jar enroll genkeys --authkeystore /opt/ejbca/p12/superadmin.p12 --authkeystorepass **** --endentityprofile "Server" --certificateprofile "Server" --ca ServerCA --subjectaltname "dnsName=test-erces-01.test" --hostname localhost --destination ./certs --subjectdn "C=SE,O=Keyfactor Community,CN=test-erces-01.test" --username test-erces-01.test -p --keyalg EC --keyspec P-256 --verbose
```
## Supported Endpoints
- /v1/ca_management
- /v1/ca_management/{ca_name}/deactivate
- /v1/ca_management/{ca_name}/activate
- v1/ca
- v1/ca/{subject_dn}/certificate/download
- v1/ca/{issuer_dn}/getLatestCrl
- /v1/ca/{issuer_dn}/createcrl
- v1/certificate
- v1/certificate/pkcs10enroll
- v1/certificate/{issuer_dn}/{certificate_serial_number}/revoke
- v2/certificate
- v2/certificate/status
- v2/certificate/count
- v1/configdump
### Additional Commands
- Stress Test
## Community Support
In the [Keyfactor Community](https://www.keyfactor.com/community/), we welcome contributions.
The Community software is open-source and community-supported, meaning that **no SLA** is applicable.
* To report a problem or suggest a new feature, go to [Issues](../../issues).
* If you want to contribute actual bug fixes or proposed enhancements, see the [Contributing Guidelines](CONTRIBUTING.md) and go to [Pull requests](../../pulls).
## Commercial Support
Commercial support is available for [EJBCA Enterprise](https://www.keyfactor.com/products/ejbca-enterprise/).
## License
For license information, see [LICENSE](LICENSE).
## Related Projects
### On GitHub
See all [Keyfactor EJBCA GitHub projects](https://github.com/orgs/Keyfactor/repositories?q=ejbca).
### On DockerHub
See the [EJBCA container on DockerHub](https://hub.docker.com/r/keyfactor/ejbca-ce).
TESTING