Skip to content

correct casing of x-hub-signature headers#20135

Merged
cmwilson21 merged 2 commits into
mainfrom
unknown repository
Aug 29, 2022
Merged

correct casing of x-hub-signature headers#20135
cmwilson21 merged 2 commits into
mainfrom
unknown repository

Conversation

@ghost

@ghost ghost commented Aug 24, 2022

Copy link
Copy Markdown

The header as it is sent is x-hub-signature not X-Hub-Signature. Casing won't matter if you're getting the header from an environment variable under Apache, as in the Ruby example here (Apache uppercases it and swaps in underscores for hyphens), but in other frameworks you'll need the correct casing to get the header out of a hash/dict. (e.g. AWS Lambda function URL, the headers come as part of a JSON object and you need the correct casing)

Why:

Closes #20134

What's being changed (if available, include any code snippets, screenshots, or gifs):

X-Hub-Signature -> x-hub-signature
X-Hub-Signature-256 -> x-hub-signature-256

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

The header as it is sent is `x-hub-signature` not `X-Hub-Signature`. Casing won't matter if you're getting the header from an environment variable under Apache, as in the Ruby example here (Apache uppercases it and swaps in underscores for hyphens), but in other frameworks you'll need the correct casing to get the header out of a hash/dict. (e.g. AWS Lambda function URL, the headers come as part of a JSON object and you need the correct casing)
@welcome

welcome Bot commented Aug 24, 2022

Copy link
Copy Markdown

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Aug 24, 2022
@github-actions

github-actions Bot commented Aug 24, 2022

Copy link
Copy Markdown
Contributor

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
developers/webhooks-and-events/webhooks/securing-your-webhooks.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21

Copy link
Copy Markdown
Contributor

@jerry-aws Thanks for opening a PR and linking it to your issue! I'll get this triaged for review! ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review webhooks Content related to webhooks developers Content related to developers and removed triage Do not begin working on this issue until triaged by the team labels Aug 25, 2022

@skedwards88 skedwards88 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this PR! We'll get this merged down for you.

@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label Aug 26, 2022

@Akenndy Akenndy left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

SECURITY.md

@cmwilson21 cmwilson21 merged commit 06b62d0 into github:main Aug 29, 2022
@github-actions

Copy link
Copy Markdown
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team developers Content related to developers ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review webhooks Content related to webhooks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Case of X-Hub-Signature-256 header is incorrect in "Securing your webhooks" topic

4 participants