oauth.erl 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. -module(oauth).
  2. -export([get/3, get/5, get/6, post/3, post/5, post/6, put/6, put/7, uri/2, header/1,
  3. sign/6, params_decode/1, token/1, token_secret/1, verify/6]).
  4. -export([plaintext_signature/2, hmac_sha1_signature/5,
  5. hmac_sha1_signature/3, rsa_sha1_signature/4, rsa_sha1_signature/2,
  6. signature_base_string/3, params_encode/1]).
  7. -export([plaintext_verify/3, hmac_sha1_verify/6, hmac_sha1_verify/4,
  8. rsa_sha1_verify/5, rsa_sha1_verify/3]).
  9. -export([header_params_encode/1, header_params_decode/1,
  10. uri_params_encode/1, uri_params_decode/1]).
  11. -include_lib("public_key/include/public_key.hrl").
  12. get(URL, ExtraParams, Consumer) ->
  13. get(URL, ExtraParams, Consumer, "", "").
  14. get(URL, ExtraParams, Consumer, Token, TokenSecret) ->
  15. get(URL, ExtraParams, Consumer, Token, TokenSecret, []).
  16. get(URL, ExtraParams, Consumer, Token, TokenSecret, HttpcOptions) ->
  17. SignedParams = sign("GET", URL, ExtraParams, Consumer, Token, TokenSecret),
  18. http_request(get, {uri(URL, SignedParams), []}, HttpcOptions).
  19. post(URL, ExtraParams, Consumer) ->
  20. post(URL, ExtraParams, Consumer, "", "").
  21. post(URL, ExtraParams, Consumer, Token, TokenSecret) ->
  22. post(URL, ExtraParams, Consumer, Token, TokenSecret, []).
  23. post(URL, ExtraParams, Consumer, Token, TokenSecret, HttpcOptions) ->
  24. SignedParams = sign("POST", URL, ExtraParams, Consumer, Token, TokenSecret),
  25. http_request(post, {URL, [], "application/x-www-form-urlencoded", uri_params_encode(SignedParams)}, HttpcOptions).
  26. put(URL, ExtraParams, {ContentType, Body}, Consumer, Token, TokenSecret) ->
  27. put(URL, ExtraParams, {ContentType, Body}, Consumer, Token, TokenSecret, []).
  28. put(URL, ExtraParams, {ContentType, Body}, Consumer, Token, TokenSecret, HttpcOptions) ->
  29. SignedParams = sign("PUT", URL, ExtraParams, Consumer, Token, TokenSecret),
  30. http_request(put, {uri(URL, SignedParams), [], ContentType, Body}, HttpcOptions).
  31. uri(Base, []) ->
  32. Base;
  33. uri(Base, Params) ->
  34. lists:concat([Base, "?", uri_params_encode(Params)]).
  35. header(Params) ->
  36. {"Authorization", "OAuth " ++ header_params_encode(Params)}.
  37. token(Params) ->
  38. proplists:get_value("oauth_token", Params).
  39. token_secret(Params) ->
  40. proplists:get_value("oauth_token_secret", Params).
  41. consumer_key(_Consumer={Key, _, _}) ->
  42. Key.
  43. consumer_secret(_Consumer={_, Secret, _}) ->
  44. Secret.
  45. signature_method(_Consumer={_, _, Method}) ->
  46. Method.
  47. sign(HttpMethod, URL, Params, Consumer, Token, TokenSecret) ->
  48. SignatureParams = signature_params(Consumer, Params, Token),
  49. Signature = signature(HttpMethod, URL, SignatureParams, Consumer, TokenSecret),
  50. [{"oauth_signature", Signature} | SignatureParams].
  51. signature_params(Consumer, Params, "") ->
  52. signature_params(Consumer, Params);
  53. signature_params(Consumer, Params, Token) ->
  54. signature_params(Consumer, [{"oauth_token", Token} | Params]).
  55. signature_params(Consumer, Params) ->
  56. Timestamp = unix_timestamp(),
  57. Nonce = base64:encode_to_string(crypto:rand_bytes(32)), % cf. ruby-oauth
  58. [ {"oauth_version", "1.0"}
  59. , {"oauth_nonce", Nonce}
  60. , {"oauth_timestamp", integer_to_list(Timestamp)}
  61. , {"oauth_signature_method", signature_method_string(Consumer)}
  62. , {"oauth_consumer_key", consumer_key(Consumer)}
  63. | Params
  64. ].
  65. verify(Signature, HttpMethod, URL, Params, Consumer, TokenSecret) ->
  66. case signature_method(Consumer) of
  67. plaintext ->
  68. plaintext_verify(Signature, Consumer, TokenSecret);
  69. hmac_sha1 ->
  70. hmac_sha1_verify(Signature, HttpMethod, URL, Params, Consumer, TokenSecret);
  71. rsa_sha1 ->
  72. rsa_sha1_verify(Signature, HttpMethod, URL, Params, Consumer)
  73. end.
  74. signature(HttpMethod, URL, Params, Consumer, TokenSecret) ->
  75. case signature_method(Consumer) of
  76. plaintext ->
  77. plaintext_signature(Consumer, TokenSecret);
  78. hmac_sha1 ->
  79. hmac_sha1_signature(HttpMethod, URL, Params, Consumer, TokenSecret);
  80. rsa_sha1 ->
  81. rsa_sha1_signature(HttpMethod, URL, Params, Consumer)
  82. end.
  83. signature_method_string(Consumer) ->
  84. case signature_method(Consumer) of
  85. plaintext ->
  86. "PLAINTEXT";
  87. hmac_sha1 ->
  88. "HMAC-SHA1";
  89. rsa_sha1 ->
  90. "RSA-SHA1"
  91. end.
  92. plaintext_signature(Consumer, TokenSecret) ->
  93. uri_join([consumer_secret(Consumer), TokenSecret]).
  94. plaintext_verify(Signature, Consumer, TokenSecret) ->
  95. verify_in_constant_time(Signature, plaintext_signature(Consumer, TokenSecret)).
  96. hmac_sha1_signature(HttpMethod, URL, Params, Consumer, TokenSecret) ->
  97. BaseString = signature_base_string(HttpMethod, URL, Params),
  98. hmac_sha1_signature(BaseString, Consumer, TokenSecret).
  99. hmac_sha1_signature(BaseString, Consumer, TokenSecret) ->
  100. Key = uri_join([consumer_secret(Consumer), TokenSecret]),
  101. base64:encode_to_string(hmac_sha(Key, BaseString)).
  102. hmac_sha1_verify(Signature, HttpMethod, URL, Params, Consumer, TokenSecret) ->
  103. verify_in_constant_time(Signature, hmac_sha1_signature(HttpMethod, URL, Params, Consumer, TokenSecret)).
  104. hmac_sha1_verify(Signature, BaseString, Consumer, TokenSecret) ->
  105. verify_in_constant_time(Signature, hmac_sha1_signature(BaseString, Consumer, TokenSecret)).
  106. hmac_sha(Key, Data) ->
  107. case erlang:function_exported(crypto, hmac, 3) of
  108. true ->
  109. crypto:hmac(sha, Key, Data);
  110. false ->
  111. crypto:sha_mac(Key, Data)
  112. end.
  113. rsa_sha1_signature(HttpMethod, URL, Params, Consumer) ->
  114. BaseString = signature_base_string(HttpMethod, URL, Params),
  115. rsa_sha1_signature(BaseString, Consumer).
  116. rsa_sha1_signature(BaseString, Consumer) ->
  117. Key = read_private_key(consumer_secret(Consumer)),
  118. base64:encode_to_string(public_key:sign(list_to_binary(BaseString), sha, Key)).
  119. rsa_sha1_verify(Signature, HttpMethod, URL, Params, Consumer) ->
  120. BaseString = signature_base_string(HttpMethod, URL, Params),
  121. rsa_sha1_verify(Signature, BaseString, Consumer).
  122. rsa_sha1_verify(Signature, BaseString, Consumer) when is_binary(BaseString) ->
  123. Key = read_cert_key(consumer_secret(Consumer)),
  124. public_key:verify(BaseString, sha, base64:decode(Signature), Key);
  125. rsa_sha1_verify(Signature, BaseString, Consumer) when is_list(BaseString) ->
  126. rsa_sha1_verify(Signature, list_to_binary(BaseString), Consumer).
  127. verify_in_constant_time(<<X/binary>>, <<Y/binary>>) ->
  128. verify_in_constant_time(binary_to_list(X), binary_to_list(Y));
  129. verify_in_constant_time(X, Y) when is_list(X) and is_list(Y) ->
  130. case length(X) == length(Y) of
  131. true ->
  132. verify_in_constant_time(X, Y, 0);
  133. false ->
  134. false
  135. end.
  136. verify_in_constant_time([X | RestX], [Y | RestY], Result) ->
  137. verify_in_constant_time(RestX, RestY, (X bxor Y) bor Result);
  138. verify_in_constant_time([], [], Result) ->
  139. Result == 0.
  140. signature_base_string(HttpMethod, URL, Params) ->
  141. uri_join([HttpMethod, uri_normalize(URL), params_encode(Params)]).
  142. params_encode(Params) ->
  143. % cf. http://tools.ietf.org/html/rfc5849#section-3.4.1.3.2
  144. Encoded = [{uri_encode(K), uri_encode(V)} || {K, V} <- Params],
  145. Sorted = lists:sort(Encoded),
  146. Concatenated = [lists:concat([K, "=", V]) || {K, V} <- Sorted],
  147. string:join(Concatenated, "&").
  148. params_decode(_Response={{_, _, _}, _, Body}) ->
  149. uri_params_decode(Body).
  150. http_request(Method, Request, Options) ->
  151. httpc:request(Method, Request, [{autoredirect, false}], Options).
  152. -define(unix_epoch, 62167219200).
  153. unix_timestamp() ->
  154. calendar:datetime_to_gregorian_seconds(calendar:universal_time()) - ?unix_epoch.
  155. read_cert_key(Path) when is_list(Path) ->
  156. {ok, Contents} = file:read_file(Path),
  157. [{'Certificate', DerCert, not_encrypted}] = public_key:pem_decode(Contents),
  158. read_cert_key(public_key:pkix_decode_cert(DerCert, otp));
  159. read_cert_key(#'OTPCertificate'{tbsCertificate=Cert}) ->
  160. read_cert_key(Cert);
  161. read_cert_key(#'OTPTBSCertificate'{subjectPublicKeyInfo=Info}) ->
  162. read_cert_key(Info);
  163. read_cert_key(#'OTPSubjectPublicKeyInfo'{subjectPublicKey=Key}) ->
  164. Key.
  165. read_private_key(Path) ->
  166. {ok, Contents} = file:read_file(Path),
  167. [Info] = public_key:pem_decode(Contents),
  168. public_key:pem_entry_decode(Info).
  169. header_params_encode(Params) ->
  170. intercalate(", ", [lists:concat([uri_encode(K), "=\"", uri_encode(V), "\""]) || {K, V} <- Params]).
  171. header_params_decode(String) ->
  172. [header_param_decode(Param) || Param <- re:split(String, ",\\s*", [{return, list}]), Param =/= ""].
  173. header_param_decode(Param) ->
  174. [Key, QuotedValue] = string:tokens(Param, "="),
  175. Value = string:substr(QuotedValue, 2, length(QuotedValue) - 2),
  176. {uri_decode(Key), uri_decode(Value)}.
  177. uri_normalize(URI) ->
  178. case http_uri:parse(URI) of
  179. {ok, {Scheme, UserInfo, Host, Port, Path, _Query}} -> % R15B
  180. uri_normalize(Scheme, UserInfo, string:to_lower(Host), Port, [Path]);
  181. {Scheme, UserInfo, Host, Port, Path, _Query} ->
  182. uri_normalize(Scheme, UserInfo, string:to_lower(Host), Port, [Path]);
  183. Else ->
  184. Else
  185. end.
  186. uri_normalize(http, UserInfo, Host, 80, Acc) ->
  187. uri_normalize(http, UserInfo, [Host|Acc]);
  188. uri_normalize(https, UserInfo, Host, 443, Acc) ->
  189. uri_normalize(https, UserInfo, [Host|Acc]);
  190. uri_normalize(Scheme, UserInfo, Host, Port, Acc) ->
  191. uri_normalize(Scheme, UserInfo, [Host, ":", Port|Acc]).
  192. uri_normalize(Scheme, [], Acc) ->
  193. lists:concat([Scheme, "://" | Acc]);
  194. uri_normalize(Scheme, UserInfo, Acc) ->
  195. lists:concat([Scheme, "://", UserInfo, "@" | Acc]).
  196. uri_params_encode(Params) ->
  197. intercalate("&", [uri_join([K, V], "=") || {K, V} <- Params]).
  198. uri_params_decode(String) ->
  199. [uri_param_decode(Substring) || Substring <- string:tokens(String, "&")].
  200. uri_param_decode(String) ->
  201. [Key, Value] = string:tokens(String, "="),
  202. {uri_decode(Key), uri_decode(Value)}.
  203. uri_join(Values) ->
  204. uri_join(Values, "&").
  205. uri_join(Values, Separator) ->
  206. string:join(lists:map(fun uri_encode/1, Values), Separator).
  207. intercalate(Sep, Xs) ->
  208. lists:concat(intersperse(Sep, Xs)).
  209. intersperse(_, []) ->
  210. [];
  211. intersperse(_, [X]) ->
  212. [X];
  213. intersperse(Sep, [X | Xs]) ->
  214. [X, Sep | intersperse(Sep, Xs)].
  215. uri_encode(Term) when is_integer(Term) ->
  216. integer_to_list(Term);
  217. uri_encode(Term) when is_atom(Term) ->
  218. uri_encode(atom_to_list(Term));
  219. uri_encode(Term) when is_binary(Term) ->
  220. uri_encode(binary_to_list(Term));
  221. uri_encode(Term) when is_list(Term) ->
  222. uri_encode(lists:reverse(Term, []), []).
  223. -define(is_alphanum(C), C >= $A, C =< $Z; C >= $a, C =< $z; C >= $0, C =< $9).
  224. uri_encode([X | T], Acc) when ?is_alphanum(X); X =:= $-; X =:= $_; X =:= $.; X =:= $~ ->
  225. uri_encode(T, [X | Acc]);
  226. uri_encode([X | T], Acc) ->
  227. NewAcc = [$%, dec2hex(X bsr 4), dec2hex(X band 16#0f) | Acc],
  228. uri_encode(T, NewAcc);
  229. uri_encode([], Acc) ->
  230. Acc.
  231. uri_decode(Str) when is_list(Str) ->
  232. uri_decode(Str, []).
  233. uri_decode([$%, A, B | T], Acc) ->
  234. uri_decode(T, [(hex2dec(A) bsl 4) + hex2dec(B) | Acc]);
  235. uri_decode([X | T], Acc) ->
  236. uri_decode(T, [X | Acc]);
  237. uri_decode([], Acc) ->
  238. lists:reverse(Acc, []).
  239. -compile({inline, [{dec2hex, 1}, {hex2dec, 1}]}).
  240. dec2hex(N) when N >= 10 andalso N =< 15 ->
  241. N + $A - 10;
  242. dec2hex(N) when N >= 0 andalso N =< 9 ->
  243. N + $0.
  244. hex2dec(C) when C >= $A andalso C =< $F ->
  245. C - $A + 10;
  246. hex2dec(C) when C >= $0 andalso C =< $9 ->
  247. C - $0.