diff --git a/README.md b/README.md index 7230b39..98159f7 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,39 @@ +

-# EJBCA Vault PKI Secrets Engine -EJBCA PKI Engine and Backend for HashiCorp Vault. Used to issue, sign, and revoke certificates using the EJBCA CA via HashiCorp Vault +EJBCA Vault PKI Secrets Engine -#### Integration status: Production - Ready for use in production environments. +Integration Status: production +Latest Release +Valid for EJBCA Community +Valid for EJBCA Enterprise +Go Report Card +License Apache 2.0 -## About the Keyfactor API Client -This API client allows for programmatic management of Keyfactor resources. -## Support for EJBCA Vault PKI Secrets Engine +

-EJBCA Vault PKI Secrets Engine is open source and supported on best effort level for this tool/library/client. This means customers can report Bugs, Feature Requests, Documentation amendment or questions as well as requests for customer information required for setup that needs Keyfactor access to obtain. Such requests do not follow normal SLA commitments for response or resolution. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com/ +

+ + + Support + + · + + Get Started + + · + + License + + · + + Related Integrations + +

-###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab. - ---- - - ---- - - - - - - EJBCA logo - - - - EJBCA logo - - - -# EJBCA PKI Secrets Engine for HashiCorp Vault - -[![Go Report Card](https://goreportcard.com/badge/github.com/Keyfactor/ejbca-vault-pki-engine)](https://goreportcard.com/report/github.com/Keyfactor/ejbca-vault-pki-engine) - - - +## Overview The EJBCA PKI Secrets Engine for HashiCorp Vault enables DevOps teams to request and retrieve certificates from EJBCA using HashiCorp Vault, while security teams retain control over backend PKI operations. @@ -48,49 +44,42 @@ The EJBCA PKI Secrets Engine is a Vault plugin that replicates the built-in Vaul requests through EJBCA instead of through Vault. The plugin was designed to be swapped for the built-in Vault PKI secrets engine with minimal changes to existing Vault configurations. -## Get Started - +## Support -To get started with EJBCA PKI Secrets Engine for HashiCorp Vault, see [Getting Started](docs/getting-started.md). +In the [Keyfactor Community](https://www.keyfactor.com/community/), we welcome contributions. Keyfactor Community software is open-source and community-supported, meaning that **no SLA** is applicable. Keyfactor will address issues as resources become available. -### System Requirements +* To report a problem or suggest a new feature, go to [Issues](../../issues). +* If you want to contribute bug fixes or proposed enhancements, see the [Contributing Guidelines](CONTRIBUTING.md) and create a [Pull request](../../pulls). - -To run the EJBCA PKI Secrets Engine for HashiCorp Vault, the EJBCA REST API needs to be set up with certain endpoints. There are also requirements on certain versions of Git, Golang, EJBCA, and HashiCorp Vault. +> Commercial support is available for [EJBCA Enterprise](https://www.keyfactor.com/products/ejbca-enterprise/) customers, who may request escalation by opening up a support ticket through their Keyfactor representative. -See the complete list in [System Requirements](docs/getting-started.md#requirements). +## Requirements -## Community Support -In the [Keyfactor Community](https://www.keyfactor.com/community/), we welcome contributions. +* [EJBCA](https://ejbca.org) (>= 7.10) +* [Terraform](https://www.terraform.io/downloads) (>= 1.0) +* [Go](https://go.dev/doc/install) (1.22.3) +* [GNU Make](https://www.gnu.org/software/make/) -The Community software is open-source and community-supported, meaning that **no SLA** is applicable. +### To build +* [Git](https://git-scm.com/) +* [Golang](https://golang.org/) >= v1.19 -* 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). +### To use +* [EJBCA](https://www.keyfactor.com/products/ejbca-enterprise/) >= v7.7 +* [HashiCorp Vault](https://www.vaultproject.io/) >= v1.11.0 -## Commercial Support -Commercial support is available for [EJBCA Enterprise](https://www.keyfactor.com/products/ejbca-enterprise/). - +## Getting Started + +To get started with EJBCA PKI Secrets Engine for HashiCorp Vault, see [Getting Started](docs/getting-started.md). -## License - -For License information, see [LICENSE](LICENSE). -## Related Projects -See all [Keyfactor EJBCA GitHub projects](https://github.com/orgs/Keyfactor/repositories?q=ejbca). +## License +For license information, see [LICENSE](LICENSE). +## Related Projects +See all [Keyfactor EJBCA GitHub projects](https://github.com/orgs/Keyfactor/repositories?q=ejbca). \ No newline at end of file diff --git a/docsource/overview.md b/docsource/overview.md new file mode 100644 index 0000000..6f39c8b --- /dev/null +++ b/docsource/overview.md @@ -0,0 +1,32 @@ +# Overview + +The EJBCA PKI Secrets Engine for HashiCorp Vault enables DevOps teams to request and retrieve certificates +from EJBCA using HashiCorp Vault, while security teams retain control over backend PKI operations. + +The secrets engine is built on top of the [EJBCA REST API](https://doc.primekey.com/ejbca/ejbca-operations/ejbca-ca-concept-guide/protocols/ejbca-rest-interface) +and uses the [EJBCA Go Client SDK](https://github.com/Keyfactor/ejbca-go-client-sdk) for programmatic access. +The EJBCA PKI Secrets Engine is a Vault plugin that replicates the built-in Vault PKI secrets engine, but processes +requests through EJBCA instead of through Vault. The plugin was designed to be swapped for the built-in Vault PKI secrets engine +with minimal changes to existing Vault configurations. + +# Requirements + +## To build +* [Git](https://git-scm.com/) +* [Golang](https://golang.org/) >= v1.19 + +## To use +* [EJBCA](https://www.keyfactor.com/products/ejbca-enterprise/) >= v7.7 +* [HashiCorp Vault](https://www.vaultproject.io/) >= v1.11.0 + +# Badges + +Latest Release +Valid for EJBCA Community +Valid for EJBCA Enterprise +Go Report Card +License Apache 2.0 + +# Getting Started + +To get started with EJBCA PKI Secrets Engine for HashiCorp Vault, see [Getting Started](docs/getting-started.md). diff --git a/integration-manifest.json b/integration-manifest.json index 3b2d440..16fec45 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -1,10 +1,11 @@ { - "$schema": "https://keyfactor.github.io/integration-manifest-schema.json", + "$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json", "name": "EJBCA Vault PKI Secrets Engine", - "integration_type": "api-client", + "integration_type": "ejbca", "status": "production", "description": "EJBCA PKI Engine and Backend for HashiCorp Vault. Used to issue, sign, and revoke certificates using the EJBCA CA via HashiCorp Vault", "support_level": "kf-community", "update_catalog": true, - "release_dir": "" + "release_dir": "", + "link_github": true } diff --git a/readme_source.md b/readme_source.md deleted file mode 100644 index 2533a18..0000000 --- a/readme_source.md +++ /dev/null @@ -1,70 +0,0 @@ - - - EJBCA logo - - - - EJBCA logo - - - -# EJBCA PKI Secrets Engine for HashiCorp Vault - -[![Go Report Card](https://goreportcard.com/badge/github.com/Keyfactor/ejbca-vault-pki-engine)](https://goreportcard.com/report/github.com/Keyfactor/ejbca-vault-pki-engine) - - - - -The EJBCA PKI Secrets Engine for HashiCorp Vault enables DevOps teams to request and retrieve certificates -from EJBCA using HashiCorp Vault, while security teams retain control over backend PKI operations. - -The secrets engine is built on top of the [EJBCA REST API](https://doc.primekey.com/ejbca/ejbca-operations/ejbca-ca-concept-guide/protocols/ejbca-rest-interface) -and uses the [EJBCA Go Client SDK](https://github.com/Keyfactor/ejbca-go-client-sdk) for programmatic access. -The EJBCA PKI Secrets Engine is a Vault plugin that replicates the built-in Vault PKI secrets engine, but processes -requests through EJBCA instead of through Vault. The plugin was designed to be swapped for the built-in Vault PKI secrets engine -with minimal changes to existing Vault configurations. - -## Get Started - - - -To get started with EJBCA PKI Secrets Engine for HashiCorp Vault, see [Getting Started](docs/getting-started.md). - -### System Requirements - - -To run the EJBCA PKI Secrets Engine for HashiCorp Vault, the EJBCA REST API needs to be set up with certain endpoints. There are also requirements on certain versions of Git, Golang, EJBCA, and HashiCorp Vault. - -See the complete list in [System Requirements](docs/getting-started.md#requirements). - -## 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 -See all [Keyfactor EJBCA GitHub projects](https://github.com/orgs/Keyfactor/repositories?q=ejbca).