Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for authorization principal in webhooks. #257

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for authorization principal in webhooks. #257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions step-ca/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,12 @@ The request will contain the `scepChallenge` provided by the client and the `sce
Unlike webhooks configured on other provisioners, when a single SCEP provisioner is configured with multiple `SCEPCHALLENGE` webhooks,
only a single one of the `SCEPCHALLENGE` webhooks needs to indicate the request is allowed for the certificate to be issued.

### Webhooks for Cloud (AWS, Azure, GCP) and X5C Provisioners
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this. I think, for completeness, people should know which attributes to expect in the webhook request. We should show an example request, or at least the names of attributes for the IID instance ID and the certificate subject.


When signing requests are authorized by one of these provisioners, the request body will also contain the authorizing principal(s)
from the request. For cloud provisioners, this will be the instance identifier from the [Instance Identity Document](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-identity-documents.html),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may need a link for the other cloud provisioners too.

and for X5C provisioners, this will be the certificate subject of the presented leaf certificate.

### SSH Request Body

For SSH certificates `step-ca` will include an `sshCertificateRequest` field with [data from the request](https://github.com/smallstep/certificates/blob/c169defc73db6ba4b83e1acd5bd31feafb4df050/webhook/types.go#L37).
Expand Down