Подписка на минимальное количество событий
Вы должны подписаться только на нужные события веб-перехватчика. Это приведет к сокращению объема работы, необходимой для сервера. Дополнительные сведения о подписке на события см. в разделе AUTOTITLE и AUTOTITLE.
Использование секрета веб-перехватчика
Предупреждение
Чтобы избежать случайного раскрытия конфиденциальной информации, не включайте конфиденциальную информацию в URL-адрес полезных данных. Это включает собственные ключи API и другие учетные данные проверки подлинности. Вместо этого, чтобы убедиться, что поставки веб-перехватчика были отправлены GitHub и не были изменены, используйте секрет веб-перехватчика. Дополнительные сведения см. в разделе AUTOTITLE.
Секрет веб-перехватчика должен быть случайной строкой текста с высокой энтропией. Вы должны безопасно хранить секрет веб-перехватчика таким образом, чтобы к серверу можно было получить доступ.
Использование проверки HTTPS и SSL
Убедитесь, что сервер использует подключение HTTPS. По умолчанию GitHub проверяет SSL-сертификаты при доставке веб-перехватчиков. GitHub рекомендует оставить включенную проверку SSL.
Ответ в 30 секунды
Сервер должен отвечать на ответ 2XX в 30 секунды получения доставки веб-перехватчика. Если сервер занимает больше времени, чем для ответа, GitHub завершает подключение и рассматривает сбой доставки.
Чтобы своевременно реагировать, может потребоваться настроить очередь для обработки полезных данных веб-перехватчика асинхронно. Сервер может реагировать, когда он получает веб-перехватчик, а затем обрабатывать полезные данные в фоновом режиме, не блокируя будущие поставки веб-перехватчика. Например, вы можете использовать сервисы вроде Hookdeck или библиотеки вроде Resque (Ruby), RQ (Python) или RabbitMQ (Java).
Проверка типа события и действия перед обработкой события
Существует несколько типов событий веб-перехватчика, и многие события могут иметь несколько типов действий. GitHub продолжает добавлять новые типы событий и новые действия в существующие типы событий. Приложение должно проверить тип события и действие полезных данных веб-перехватчика перед обработкой полезных данных. Для определения типа события можно использовать заголовок запроса X-#REF!-Event. Чтобы определить тип действия, можно использовать ключ верхнего уровня в полезных данных события.
Redeliver пропущенные поставки
Если сервер выходит из строя, вы должны повторно создать пропущенные веб-перехватчики после резервного копирования сервера. Дополнительные сведения см. в разделе AUTOTITLE.
Используйте заголовок X-#REF!-Delivery
В атаке воспроизведения плохой субъект перехватывает доставку веб-перехватчика и повторно отправляет доставку. Чтобы защититься от повторных атак, можно использовать заголовок X-#REF!-Delivery, чтобы каждая подача была уникальной для каждого события.
Примечание.
Если вы запросите повторную доставку, заголовок X-#REF!-Delivery будет таким же, как и при первоначальной доставке.
Дополнительные материалы
- AUTOTITLE
- AUTOTITLE