vcert

Este proyecto de código abierto cuenta con el apoyo de la comunidad. Para informar un problema o compartir una idea, utilice Problemas ; y si tiene alguna sugerencia para solucionar el problema, incluya también esos detalles. Además, utilice solicitudes de extracción para contribuir con correcciones de errores reales o mejoras propuestas. Damos la bienvenida y apreciamos todas las contribuciones. ¿Tiene preguntas o quiere discutir algo con nuestro equipo? ¡Únase a nosotros en Slack !

VCert

VCert es una biblioteca Go, un SDK y una utilidad de línea de comandos diseñada para simplificar la generación de claves y el registro de identidades de máquinas (también conocidas como claves y certificados SSL/TLS) que cumplen con la política de seguridad empresarial mediante el uso de Venafi Trust Protection Platform o Venafi Control Plane. o Venafi Luciérnaga.

Consulte VCert CLI para Venafi Trust Protection Platform o VCert CLI para Venafi Control Plane o VCert CLI para Venafi Firefly para comenzar con la utilidad de línea de comandos.

Compatibilidad

Las versiones de VCert se prueban utilizando la última versión de Trust Protection Platform. La funcionalidad general de la última versión de VCert debe ser compatible con Trust Protection Platform 17.3 o superior. Los campos personalizados y el seguimiento de instancias requieren TPP 18.2 o superior, y la autenticación de token requiere TPP 20.1 o superior.

Configuración del desarrollador

1. Configure su entorno Go de acuerdo con https://golang.org/doc/install.

2. Verifique que la variable de entorno GOPATH esté configurada correctamente

3. Descarga el código fuente:

   go get github.com/Venafi/vcert/v5

   o anterior a Go 1.13

   git clone https://github.com/Venafi/vcert.git $GOPATH /src/github.com/Venafi/vcert/v5

   Vaya a 1.11 con los módulos go habilitados o vaya a 1.13 y versiones posteriores, asegúrese de clonar fuera de $GOPATH/src

   git clone https://github.com/Venafi/vcert.git

4. Cree las utilidades de línea de comandos para Linux, macOS y Windows:

   make build

Usando VCert para integrar Venafi con su aplicación

Para ver ejemplos de código de uso programático, revise los archivos en la carpeta de ejemplos.

parte común

1. En su archivo main.go , haga las siguientes declaraciones de importación:

    import (
       "github.com/Venafi/vcert/v5"
       "github.com/Venafi/vcert/v5/pkg/certificate"
       "github.com/Venafi/vcert/v5/pkg/endpoint"
   )

2. Cree un objeto de configuración de tipo &vcert.Config que especifique los detalles de la conexión de Venafi. Las soluciones suelen estar diseñadas para obtener esos detalles de una bóveda de secretos, un archivo .ini, variables de entorno o parámetros de línea de comandos.

Inscribir certificado

1. Cree una instancia de un cliente llamando al método NewClient de la clase vcert con el objeto de configuración.
2. Redacte un objeto de solicitud de certificado de tipo &certificate.Request .
3. Genere un par de claves y una CSR para la solicitud de certificado llamando al método GenerateRequest del cliente.
4. Envíe la solicitud pasando el objeto de solicitud de certificado al método RequestCertificate del cliente.
5. Utilice el ID de solicitud para recoger el certificado mediante el método RetrieveCertificate del cliente.

Nuevo oyente TLS para dominio

1. Llame al método vcert.Config NewListener con una lista de dominios como argumentos. Por ejemplo ("test.example.com:8443", "example.com")
2. Utilice get net.Listener como argumento para http.Serve integrado u otros servidores https.

Los ejemplos se encuentran en un estado en el que puede compilarlos/ejecutarlos usando los siguientes comandos (después de configurar las variables de entorno que se analizan más adelante):

go build -o cli ./example
go test -v ./example -run TestRequestCertificate

Requisitos previos para usar con Trust Protection Platform

1. Una cuenta de usuario a la que se le ha concedido acceso WebSDK
2. Una carpeta (zona) donde al usuario se le han otorgado los siguientes permisos: View , Read , Write , Create , Revoke (para la acción de revocación) y Private Key Read (para la acción de recogida cuando se genera el servicio CSR)
3. Política aplicada a la carpeta que especifica:
   1. Plantilla de CA que Trust Protection Platform utilizará para inscribir las solicitudes de certificado enviadas por VCert
   2. Valores de DN del sujeto para unidad organizativa (OU), organización (O), ciudad (L), estado (ST) y país (C)
   3. Tipo de gestión no bloqueado o bloqueado en 'Inscripción'
   4. Generación de solicitud de firma de certificado (CSR) desbloqueada o no bloqueada en 'CSR generada por servicio'
   5. Generar clave/CSR en la aplicación no bloqueada o bloqueada en 'No'
   6. (Recomendado) Desactivar la renovación automática configurada en "Sí"
   7. (Recomendado) Fuerza de bits clave establecida en 2048 o superior
   8. (Recomendado) Política de lista blanca de dominios asignada adecuadamente

El requisito de que la plantilla de CA sea asignada por política sigue una de las mejores prácticas de Venafi de larga data que también cumplió con nuestro objetivo de diseño de mantener el proceso de solicitud de certificado simple para los usuarios de VCert. Si necesita la capacidad de especificar la plantilla de CA con la solicitud, puede utilizar las API REST de TPP, pero tenga en cuenta que esto va en contra de las recomendaciones de Venafi.

Pruebas con Trust Protection Platform y Venafi Control Plane

Pruebas unitarias:

make test

Las pruebas de integración para Trust Protection Platform y Venafi Control Plane requieren acceso a esos productos. Las variables de entorno se utilizan para especificar la configuración requerida, incluidas las credenciales. La clave API del plano de control de Venafi y los fragmentos de valores de zona (es decir, Application Name Issuing Template API Alias ) están disponibles en la interfaz web.

 export TPP_URL=https://tpp.venafi.example/vedsdk
export TPP_USER=tpp-user
export TPP_PASSWORD=tpp-password
export TPP_ZONE= ' somesuggested_policy '
export TPP_ZONE_RESTRICTED= ' somelocked_policy '
export TPP_ZONE_ECDSA= ' someecdsa_policy '

make tpp_test

 export CLOUD_URL=https://api.venafi.cloud/v1
export CLOUD_APIKEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLOUD_ZONE= ' My ApplicationPermissive CIT '
export CLOUD_ZONE_RESTRICTED= ' Your ApplicationRestrictive CIT '

make cloud_test

Las pruebas de utilidad de línea de comandos utilizan archivos de funciones de Cucumber & Aruba.

• Para ejecutar pruebas para todas las funciones en paralelo:

  make cucumber

• Para ejecutar pruebas solo para una característica específica:

  make cucumber FEATURE=./features/basic/version.feature

  Las características disponibles son:

  • basic
  • config
  • enroll
  • format
  • gencsr
  • renew
  • revoke

Cuando se ejecuten, estas pruebas se ejecutarán en su propio contenedor Docker utilizando la versión Ruby de Cucumber.
La ejecución de prueba completa informará sobre la cantidad de escenarios de prueba y pasos que pasaron, fallaron o se omitieron.

Funcionalidad del libro de jugadas

Para obtener explicaciones detalladas sobre el libro de jugadas y cómo se construye, consulta aquí: Léame Playbook

Contribuyendo a VCert

Venafi agradece las contribuciones de la comunidad de desarrolladores.

1. Bifurquelo en su cuenta (https://github.com/Venafi/vcert/fork)
2. Clona tu tenedor:

   git clone [email protected]:youracct/vcert.git

3. Crea una rama de características:

   git checkout -b your-branch-name

4. Implemente y pruebe sus cambios
5. Confirme sus cambios:

   git commit -am ' Added some cool functionality '

6. Empujar a la rama

   git push origin your-branch-name

7. Cree una nueva solicitud de extracción en https://github.com/youracct/vcert/pull/new/your-branch-name

Licencia

Copyright © Venafi, Inc. Todos los derechos reservados.

VCert tiene la licencia Apache, versión 2.0. Consulte LICENCIA para obtener el texto completo de la licencia.

Dirija sus preguntas/comentarios a [email protected].