Skip to content

Commit

Permalink
Merge pull request #7 from digicert/readme-edits-11252024
Browse files Browse the repository at this point in the history
Updated first paragraph and inserted new paragraphs under it
  • Loading branch information
alexmitchell12 authored Nov 25, 2024
2 parents e8b50e7 + 0a92262 commit c9d2073
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,12 +194,12 @@ The `DnsPreparationRequest` object is used to prepare the DNS validation process

The `DnsPreparationResponse` object is returned by the `DnsValidator` after the `prepare` method is called. This preparation response object contains the necessary information to validate the DCV process, as well as the following fields:

| Field | Type | Description |
|-----------------|---------|------------------------------------------------------------|
| dnsType | DnsType | The DNS record type to use for the DCV process. |
| domain | String | The domain name to validate. |
| allowedFqdns | String | Allowed domains and sub-domains based on requested domain. |
| validationState | String | The validation state of the DCV process. |
| Field | Type | Description |
|-----------------|-----------------|------------------------------------------------------------|
| dnsType | DnsType | The DNS record type to use for the DCV process. |
| domain | String | The domain name to validate. |
| allowedFqdns | List<String> | Allowed domains and sub-domains based on requested domain. |
| validationState | ValidationState | The validation state of the DCV process. |

NOTE: The validationState object returned here will be used in the subsequent validation request

Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ Domain Control Validation
This library represents DigiCert's domain control validation (DCV) process. This is to satisfy the requirements specified in the
[CAB Forum baseline requirements](https://github.com/cabforum/servercert/blob/main/docs/BR.md#3224-validation-of-domain-authorization-or-control)
to validate that an applicant has ownership or control over a domain. The BR documents multiple methods by which such control
can be demonstrated.
can be demonstrated. This initial version of the library is available for review.

We are open-sourcing this code to improve transparency and security around Domain Control Validation. After an initial review period,
DigiCert will deploy it into production, continuing to enhance the repo as relevant, while providing ongoing transparency about our processes and best practices.

We hope that others also will find this valuable for their DCV efforts.

For each method, this library has a preparation step and a validation step. The preparation step supplies information that is
necessary for setting up the DCV, including generating a value that can be used as the required random value. The validation
Expand Down

0 comments on commit c9d2073

Please sign in to comment.