CA Services - dogtagpki/freeipa GitHub Wiki

Overview

This page describes CA services used by IPA.

General

POST /ca/admin/ca/getStatus
- GetStatus Service
- dogtag.ca_status()
/ca/ee/ca/*
/ca/agent/ca/*
/ca/rest/*

Authentication

GET /ca/rest/account/login
- PKI Login REST API
- RestClient.__enter__()
GET /ca/rest/account/logout
- PKI Logout REST API
- RestClient.__exit__()

Certificates

GET /ca/ee/ca/getCertChain
- CA EE Get Certificate Chain
- dogtag.get_ca_certchain()
POST /ca/ee/ca/profileSubmit
POST /ca/ee/ca/profileSubmitSSLClient
GET /ca/ee/ca/profileReview
POST /ca/ee/ca/profileProcess
GET /ca/ee/ca/profileList
- CA Profile List Service
- https://pagure.io/certmonger/blob/master/f/src/dogtag.c#_666
GET /ca/ee/ca/checkRequest
GET /ca/ee/ca/displayCertFromRequest
GET /ca/rest/certs/<id>
- CA Retrieve Certificate REST API
- ra.get_certificate()
POST /ca/rest/certs/search
- CA Search Certificates REST API
- ra.find()
POST /ca/rest/agent/certs/<id>/revoke
- CA Revoke Certificate REST API
- ra.revoke_certificate()
POST /ca/rest/agent/certs/<id>/unrevoke
- CA Unrevoke Certificate REST API
- ra.take_certificate_off_hold()

Certificate Requests

POST /ca/rest/certrequests
- PKI CA List Certificate Requests REST API
- ra.request_certificate()
GET /ca/rest/certrequests/<id>
- PKI CA Retrieve Certificate Request REST API
- ra.check_request_status()

Certificate Profiles

POST /ca/rest/profiles/raw
- CA Create Profile REST API
- ra_certprofile.create_profile()
GET /ca/rest/profiles/<id>/raw
- CA Get Profile REST API
- ra_certprofile.read_profile()
PUT /ca/rest/profiles/<id>/raw
- CA Update Profile REST API
- ra_certprofile.update_profile()
POST /ca/rest/profiles/<id>?action=enable
- CA Enable Profile REST API
- ra_certprofile.enable_profile()
POST /ca/rest/profiles/<id>?action=disable
- CA Disable Profile REST API
- ra_certprofile.disable_profile()
DELETE /ca/rest/profiles/<id>
- CA Delete Profile REST API
- ra_certprofile.delete_profile()

Certificate Authorities

POST /ca/rest/authorities
- CA Create Authority REST API
- ra_lightweight_ca.create_ca()
GET /ca/rest/authorities/<id>
- CA Get Authority REST API
- ra_lightweight_ca.read_ca()
POST /ca/rest/authorities/<id>/enable
- CA Enable Authority REST API
- ra_lightweight_ca.enable_ca()
POST /ca/rest/authorities/<id>/disable
- CA Disable Authority REST API
- ra_lightweight_ca.disable_ca()
GET /ca/rest/authorities/<id>/cert
- CA Get Authority Certificate REST API
- ra_lightweight_ca.read_ca_cert()
GET /ca/rest/authorities/<id>/chain
- CA Get Authority Certificate Chain REST API
- ra_lightweight_ca.read_ca_chain()
DELETE /ca/rest/authorities/<id>
- CA Delete Authority REST API
- ra_lightweight_ca.delete_ca()

Certificate Pruning

pki-server ca-config-set jobsScheduler.job.pruning.<name>
- PKI Server Subsystem Configuration CLI
- IPAACMEManage.pruning.ca_config_set()
pki-server ca-config-show jobsScheduler.job.pruning.<name>
- PKI Server Subsystem Configuration CLI
- IPAACMEManage.pruning.ca_config_show()
pki ca-job-start pruning
- PKI Job CLI
- IPAACMEManage.pruning.run_pruning()

CRL

GET /ca/ee/ca/getCRL
POST /ca/agent/ca/updateCRL
- UpdateCRL Service
- ra.updateCRL()

OCSP

POST /ca/ocsp

Security Domain

DELETE /ca/securityDomain/hosts/<id>
- SD Delete Host REST API
- ra_securitydomain.delete_domain()

⚠️ GitHub.com Fallback ⚠️