REST API 관련 컨설팅 중 학습한 내용을 공유합니다.

 

한 고객사의 요청으로 Unleashed 사의 REST 서비스와 연동을 진행했습니다.

그 과정 중 HMAC(해시 기반 메시지 인증 코드) 구현 과정을 공유합니다.

 

HMAC은 Unleashed 사 뿐아니라 AWS의 REST API 연동에도 사용되는 등 많은 REST 서비스에 구현되는 내용입니다.

MAC과 HMAC

먼저 MAC(Message Authenticate Code: 메시지 인증 코드)를 살펴봅니다.

(출처: https://ko.wikipedia.org/wiki/메시지_인증_코드)

 

MAC는 발신자(Sender)와 수신자(Receiver) 사이에 메시지 변조 여부를 확인하기 위한 메시지 인증 방식입니다.

위 그림을 통해 설명하면, 

Sender는 보내는 메시지(MESSAGE)와 지정된 키(Key)를 조합해 MAC을 만들고 메시지와 MAC을 전달합니다.

Receiver는 메시지와 MAC를 수신 후 메시지와 지정된 키를 조합해 MAC을 만들어 수신한 MAC과 비교해 데이터의 위변조를 판단할 수 있습니다.

 

HMAC(Hashed MAC)는 MAC Algorithm에 해쉬 함수를 적용해 암호화 하는 방식입니다.

 

HMAC 예시

제가 진행한 Unleashed 사는 API 요청 시 HTTP 해더에 다음 정보를 포함해야 합니다.

  • Content-Type, Accept
  • api-auth-id
  • api-auth-signature
Content-type과 Accept는 송수신 시의 데이터 포맷인 application/json을 입력하면 됩니다.
api-auth-id는 서비스 등록 시 발급받은 API ID를 입력하면 됩니다.
api-auth-signature는 HMAC을 생성해 입력해야 합니다.
 

서비스 제공사의 문서를 보면 HMAC-SHA256을 어떻게 만들어야 하는지 안내합니다.

위 문서 중 일부는 다음과 같습니다.
 
The method signature must be generated by taking the query string, and creating a HMAC-SHA256 signature using your API key as the secret key.
(메소드 시그니처는 쿼리 스트링을 가져와 API Key를 시크릿 키로 HMAC-SHA256 시그니처를 생성해야 한다.)
 

위에서 API 키는 서비스 등록시 발급받은 값입니다.

 

쿼리 스트링은 URL 중 "?" 뒤의 문자열입니다. 예를 들면

Customers?customerCode=ACME 중 customerCode=ACME가 쿼리 스트링입니다.

 

HMAC-SHA256은 다음과 같이 구현할 수 있습니다.

 

HMAC-SHA256

다음 샘플은 쿼리스트링(ProductCode=XXX)와 API Key(UNLEASHED_API_KEY: 상수)를 이용해 HMAC을 SHA256으로 시그니처를 생성해 HTTP 해더에 추가하는 내용입니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
uses
  System.Hash,          // sha256
  System.NetEncoding;   // base64
 
var
  signature: string;
  param: string;
begin
  param := 'ProductCode=' + AProductCode;
 
  // PHP: base64_encode(hash_hmac('sha256', $request, $key, true));
  signature := TBase64Encoding.Base64.EncodeBytesToString(
                  THashSHA2.GetHMACAsBytes(param, UNLEASHED_API_KEY, SHA256));
 
  RESTRequest1.Params.AddItem('api-auth-id', UNLEASHED_API_ID, pkHTTPHEADER);
  RESTRequest1.Params.AddItem('api-auth-signature', signature, pkHTTPHEADER, [poDoNotEncode]);
end;

 

추가 학습할 내용

HMAC 인증외에 OAuth 2.0 인증도 많이 사용됩니다.

다음 글을 통해 OAuth 2.0을 통해 카카오 API에 연동하는 내용을 살펴볼 수 있습니다.

 

다음 글들을 통해 REST API를 이해하고 실습할 수 있습니다.
 
번호 제목 글쓴이 날짜 조회 수
공지 [DelphiCon 요약] 코드사이트 로깅 실전 활용 기법 (Real-world CodeSite Logging Techniques) 관리자 2021.01.19 15552
공지 [UX Summit 요약] 오른쪽 클릭은 옳다 (Right Click is Right) 관리자 2020.11.16 14003
공지 [10.4 시드니] What's NEW! 신기능 자세히 보기 관리자 2020.05.27 16537
공지 RAD스튜디오(델파이,C++빌더) - 고객 사례 목록 관리자 2018.10.23 22122
공지 [데브기어 컨설팅] 모바일 앱 & 업그레이드 마이그레이션 [1] 관리자 2017.02.06 23373
공지 [전체 목록] 이 달의 기술자료 & 기술레터 관리자 2017.02.06 18966
공지 RAD스튜디오(델파이, C++빌더) - 시작하기 [1] 관리자 2015.06.30 39360
공지 RAD스튜디오(델파이,C++빌더) - 모바일 앱 개발 사례 (2020년 11월 업데이트 됨) 험프리 2014.01.16 174767
903 RAD Studio XE7에서 추가된 안드로이드 기능 익히기(동영상) Humphery 2014.11.05 2059
902 패키지 개발방식과 DLL개발방식의 차이와 장단점 김원경 2018.05.02 2051
901 [업데이트] RAD Studio XE7 Update 1 개선된 내용 Humphery 2014.11.27 2044
900 [업데이트][Hotfix] iOS 배포와 요세미티, VCL Bitmap 파일 보안취약점 패치 Humphery 2014.10.22 2044
899 [오픈소스] 델파이 컴포넌트, 프레임워크, 라이브러리, 리소스 등등 관리자 2017.02.15 2042
898 이 달의 기술자료 - 2016년 07월 file 험프리 2016.06.30 2038
897 QueryPerformanceCounter 사용 시 주의사항(x86, 64bit) Humphery 2014.05.07 2035
896 이 달의 기술자료 - 2014년 5월 file 험프리 2014.05.19 2006
895 [10.3 리오][업데이트 1] What's NEW! 신기능 자세히 보기 험프리 2019.02.18 1997
894 [Step UP! 마이그레이션] RAD 업그레이드 마이그레이션 기술 브리핑 자료(2014.8.21) 관리자 2014.08.22 1995
893 [오픈소스] Python for Delphi(P4D) [5] file 험프리 2017.09.01 1983
892 [로드맵] RAD 스튜디오 로드맵(2016년 8월) file 험프리 2016.08.12 1983
891 부산가톨릭대학교 특강 발표자료 Humphery 2014.03.13 1983
890 엔터프라이즈 커넥터 - 엠바카데로의 새로운 솔루션 [1] file 관리자 2017.07.12 1975
889 [XE8] Android 단말기 연결안될때 SDK 확인 및 설치 Humphery 2015.04.11 1966
888 Quality central Windows Client 이용방법 file Humphery 2014.04.30 1965
887 델파이로 국제화된 다국어 애플리케이션 만들기 Humphery 2014.12.10 1956
886 안드로이드 각종 설정값 제어 예제. c2design 2014.08.14 1945
885 [기술문서] 델파이와 유니코드 관리자 2014.09.16 1938
884 [발표자료] 20160830 나만의 C++애플리케이션 완성하기 with C++빌더 험프리 2016.08.26 1921