Files
backstage/plugins/events-backend-module-github/config.d.ts
T
Patrick Jungermann 0f46ec304c feat(events/github): add signature verification
Add `createGithubSignatureValidator(config)` which can be used
to create a validator used at an ingress for topic `github`.

On top, there is a new `githubWebhookEventsModule` for the new backend plugin API
which auto-registers the `HttpPostIngress` for topic `github` incl. the validator.

Relates-to: PR #13931
Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
2022-11-24 21:57:12 +01:00

37 lines
1.1 KiB
TypeScript

/*
* Copyright 2022 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface Config {
events?: {
modules?: {
/**
* events-backend-module-github plugin configuration.
*/
github?: {
/**
* Secret token for webhook requests used to verify signatures.
*
* See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks
* for more details.
*
* @visibility secret
*/
webhookSecret?: string;
};
};
};
}