HMAC 구성 - 토큰 기반 인증
REST API 엔드포인트에 대한 인증을 지원하도록 HMAC를 구성합니다.
시작하기 전에
필요한 역할: 관리자
필요한 플러그인: API 키 및 HMAC 인증(com.glide.tokenbased_auth)
프로시저
-
HMAC 구성을 생성합니다.
- 다음으로 이동 모두 > 시스템 웹 서비스 > API 접근 정책 > HMAC 구성.
-
새로 만들기를 선택합니다.
주:플러그인 설치 시 생성되는 기본 HMAC SHA256 Base64 인코딩 을 사용할 수도 있습니다.
-
양식에서 필드에 다음을 입력합니다.
표 1. HMAC 구성 필드 설명 이름 HMAC 구성의 이름입니다. 애플리케이션 구성의 범위입니다. 설명 구성에 대한 자세한 설명입니다. 해시 알고리즘 해시 알고리즘을 선택합니다. 사용 가능한 옵션: - HmacSHA256
- HmacSHA384
- HmacSHA512
HMAC 유틸리티 스크립트 HMAC에 대한 유틸리티 스크립트입니다. 주:키 ID가 없는 요청 본문, 타임스탬프 및 비밀을 사용하여 HMAC 인증을 확인하는 경우 다음을 수행합니다.- HMAC 유틸리티 스크립트로 사용자 지정된 스크립트 포함 작성
- 해당 스크립트 포함 유틸리티를 사용하여 전달된 타임스탬프 및 요청 본문을 해석합니다.
인스턴스에서 생성된 모든 공유 암호에는 ServiceNow® 키 ID가 있습니다. 키 ID를 HMAC 인증 프로필의 기본 키 ID로 구성해야 합니다.
- 기록을 제출합니다.
-
인바운드 인증 프로파일을 생성합니다.
- 다음으로 이동 모두 > 시스템 웹 서비스 > API 접근 정책 > 인바운드 인증 프로파일.
-
새로 만들기를 선택합니다.
시스템에 What kind of authentication profile(인증 프로파일의 종류)이라는 메시지가 표시됩니다.
-
HMAC 인증 프로필 만들기를 선택합니다.
-
양식에서 필드를 채웁니다.
표 2. HMAC 인증 프로파일 필드 설명 이름 인증 정책을 식별하는 이름입니다. 애플리케이션 인증 정책의 범위입니다. HMAC에 대한 구성 생성된 HMAC 구성을 선택합니다. 인증 매개변수 인증 요청에 대한 인증 매개변수를 선택합니다. 기본 옵션을 선택하거나 새 인증 매개변수를 생성할 수 있습니다. - x-sn-hmac-signature-256: 인증 헤더
- x-sn-hmac-signature-256: 쿼리 매개변수
공유 암호의 기본 키 ID HMAC를 사용하기 위해 이 필드에서 업데이트할 수 있는 토큰 정보입니다. 주:선택한 옵션은 REST 호출에서 인증 헤더 또는 쿼리 매개변수의 일부로 정의되어야 합니다. - 양식을 제출합니다.
-
HMAC 암호를 만듭니다.
- 다음으로 이동 모두 > 시스템 웹 서비스 > API 접근 정책 > REST API HMAC 암호.
- 새로 만들기를 선택합니다.
-
양식에서 필드에 다음을 입력합니다.
표 3. REST API HMAC 암호 필드 설명 이름 REST API HMAC 암호를 식별하는 이름입니다. 설명 REST API HMAC 암호에 대한 설명입니다. 활성 REST API HMAC 암호의 상태입니다. 사용자 REST API HMAC 암호와 연결된 사용자입니다. 조회 아이콘을 사용하여 사용자를 선택합니다. 키 ID REST 호출의 일부로 보내야 하는 키 ID입니다. 양식을 제출한 후 키 ID가 생성됩니다. 공유 암호 사용자의 공유 암호입니다. 예를 들어 암호입니다. 소스 기록의 소스입니다. 만료 자격 증명이 더 이상 유효하지 않게 되는 시간입니다. 값이 비어 있으면 만료되지 않습니다. 주:토큰 만료에 대한 자세한 내용은 다음 문서를 참조하십시오 토큰 만료 정리 중 . - 양식을 제출합니다.
-
생성된 기록을 엽니다.
사용자에 ServiceNow AI Platform 대해 생성된 키 ID를 찾습니다.
주:API 호출에 대한 Auth 또는 Query 매개변수를 지정하지 않으려면 HMAC에 대해 작성된 인증 프로파일의 키 ID 중에 작성된 키 ID를 추가할 수 있습니다.
-
REST API 접근 정책을 생성합니다.
- 다음으로 이동 모두 > 시스템 웹 서비스 > REST API 접근 정책.
- 새로 만들기를 선택합니다.
-
양식에서 필드를 채웁니다.
표 4. API 접근 정책 필드 설명 이름 API 접근 정책의 고유한 이름입니다. 활성 API 접근 정책을 활성화하는 옵션입니다. REST API 액세스 정책이 적용되는 REST API입니다. 예를 들어 첨부 파일 API입니다. REST API 경로 REST API의 API 경로입니다. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다. 예: now/attachment. HTTP 메서드 API와 상호작용하는 데 사용되는 메서드입니다. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다. 버전 API의 버전입니다. 예: v1. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다. 주:REST API의 모든 버전에 대한 인증 정책을 만들려면 각 버전에 대해 개별 정책을 만들어야 합니다.자원 REST API의 하위 자원입니다. 이 필드는 선택한 REST API에 따라 자동으로 채워집니다. 예: /now/attachment 애플리케이션 애플리케이션의 범위입니다. 전역 API의 모든 메서드, 버전 및 자원에 인증 정책을 적용하려면 이 필드를 활성화합니다. 주:전역 REST API 정책에서는 토큰 기반 인증을 사용할 수 없습니다.모든 메서드에 적용 API에 대한 인증 정책을 API의 모든 메서드, 버전 및 자원에 적용하려면 이 필드를 활성화합니다. 모든 자원에 적용 API에 대한 인증 정책을 모든 버전에 적용하려면 이 필드를 활성화합니다. 모든 버전에 적용 API에 대한 인증 정책을 모든 자원에 적용하려면 이 필드를 활성화합니다. -
생성된 API 인증 프로파일을 추가합니다.
-
양식을 제출합니다.
REST API 호출을 보낼 수 있습니다.
- 인증 구성에 따라 헤더 또는 쿼리 매개변수 내에서 API 키를 생성하는 동안 생성된 ServiceNow® x-sn-hmac-signature-256을 사용합니다.
- 공유 비밀이 요청의 일부로 지정된 사전 요청 스크립트
경고:중요한 정보를 서버에 제출할 때 POST 요청을 사용합니다.