Current section
Files
Jump to
Current section
Files
lib/bunck.ex
defmodule Bunck do
use Application
@moduledoc """
Bunck is a client for the Bunq API.
Configure an API key in `config.exs`:
```elixir
config Bunck. api_key: System.get_env("BUNQ_API_KEY")
```
Then you can make calls using the Bunq API. Bunck takes care of public / private keys, installation, device servers, and sessions.
Example:
```elixir
Bunck.with_session(fn(client) ->
%Bunck.User.List{} |> Bunck.request(client) # get all users
%Bunck.User.Get{user_id: 4} |> Bunck.request(client) # get user with id 4
end)
```
You can also iterate over a response using `Enum`:
```elixir
Bunck.with_session(fn(client) ->
with {:ok, res} <- %Bunck.User.List{} |> Bunck.request(client),
do: Enum.map(fn(user) -> do_something_with(user) end)
end)
```
"""
def start(_type, _args) do
import Supervisor.Spec
children = [
worker(Bunck.DeviceServer, [])
]
Supervisor.start_link(children, [strategy: :one_for_one, name: Bunck.Supervisor])
end
defmodule Response, do: defstruct [:status, :headers, :body, :client]
defimpl Enumerable, for: Response do
defmodule ResponseList, do: defstruct [:list, :next_path, :client]
def count(_), do: {:error, __MODULE__}
def member?(_,_), do: {:error, __MODULE__}
def reduce(_, {:halt, acc}, _fun), do: {:halted, acc}
def reduce(response = %Response{}, acc, fun) do
reduce(%ResponseList{list: response.body["Response"], next_path: response.body["Pagination"]["older_url"], client: response.client}, acc, fun)
end
def reduce(response_list, {:suspend, acc}, fun), do: {:suspended, acc, &reduce(response_list, &1, fun)}
def reduce(response_list = %{list: [], next_path: nil}, {:cont, acc}, fun), do: {:done, acc}
def reduce(response_list = %{list: []}, {:cont, acc}, fun) do
{:ok, new_response} = %Bunck.GetPath{path: response_list.next_path} |> Bunck.request(response_list.client)
reduce(new_response, {:cont, acc}, fun)
end
def reduce(response_list = %{list: [h|t]}, {:cont, acc}, fun) do
reduce(%{response_list | list: t}, fun.(h, acc), fun)
end
end
def request(payload, client) do
Bunck.Request.request(payload, client)
|> headers(client)
|> authenticate(client)
|> sign(client)
|> do_request(client)
end
def with_session(fun) do
Bunck.DeviceServer.get_session_client() |> fun.()
end
def get_page(response_json, which_page, client) do
path = response_json |> Map.fetch!("Pagination") |> Map.fetch!(which_page)
if path do
%Bunck.GetPath{path: path} |> request(client)
else
{:error, "No #{which_page}"}
end
end
defp headers(request, client) do
%Bunck.Request{request | headers: (request.headers || []) ++ (client.headers || []) ++ default_headers()}
end
defp default_headers do
[
"User-Agent": "Bunck Elixir Client/0.1 (+https://hex.pm/packages/bunck)",
"Cache-Control": "no-cache",
"X-Bunq-Language": "en_US",
"X-Bunq-Region": "en_US",
"X-Bunq-Client-Request-Id": UUID.uuid4(),
"X-Bunq-Geolocation": "0 0 0 0 000",
]
end
defp authenticate(request = %Bunck.Request{payload: %Bunck.Installation.Post{}}, _client), do: request
defp authenticate(request = %Bunck.Request{payload: %Bunck.SessionServer.Post{}}, client) do
%{request | headers: ["X-Bunq-Client-Authentication": client.installation_token] ++ request.headers}
end
defp authenticate(request = %Bunck.Request{payload: %Bunck.DeviceServer.Post{}}, client) do
%{request | headers: ["X-Bunq-Client-Authentication": client.installation_token] ++ request.headers}
end
defp authenticate(request, client) do
%{request | headers: ["X-Bunq-Client-Authentication": client.session_token] ++ request.headers}
end
defp sign(request, client) do
%{request | headers: ["X-Bunq-Client-Signature": signature(request, client)] ++ request.headers}
end
defp signature(_ = %Bunck.Request{payload: %Bunck.Installation.Post{}}, _client), do: ""
defp signature(request, client) do
headers_string =
request.headers
|> Enum.filter(fn header ->
header_name = elem(header, 0)
:"Cache-Control" == header_name || :"User-Agent" == header_name || header_name |> to_string() |> String.starts_with?("X-Bunq-")
end)
|> header_signature_string()
"#{request.method |> String.upcase} #{request.path}\n#{headers_string}\n\n#{request.payload |> Poison.encode!}"
|> :public_key.sign(:sha256, client.client_private_key)
|> :base64.encode()
end
defp header_signature_string(headers) do
headers
|> Enum.sort_by(fn header -> elem(header, 0) end)
|> Enum.map(fn header -> "#{elem(header, 0)}: #{elem(header, 1)}" end)
|> Enum.join("\n")
end
defp format_request_for_hackney(request) do
%{request | method: request.method |> String.downcase,
url: "https://sandbox.public.api.bunq.com#{request.path}",
payload: request.payload |> Poison.encode!(),
options: request.options || [],
}
|> Map.take([:method, :url, :headers, :payload, :options])
end
defp do_request(request, client) do
with {:ok, status, headers, body} <- do_hackney_request(request),
{:ok, status, headers, body} <- validate_response({status, headers, body}, client),
{:ok, status, headers, body} <- process_response_json({status, headers, body}) do
{:ok, %Bunck.Response{status: status, headers: headers, body: body, client: client}}
end
end
defp do_hackney_request(request) do
r = request |> format_request_for_hackney()
with {:ok, status, headers, body_stream} <- :hackney.request(r.method, r.url, r.headers, r.payload, r.options),
{:ok, body} <- :hackney.body(body_stream),
do: {:ok, status, headers, body}
end
defp validate_response({status, headers, body}, %{server_public_key: nil}), do: {:ok, status, headers, body}
defp validate_response({status, headers, body}, client) do
headers_string =
headers
|> Enum.filter(fn header ->
name = elem(header, 0) |> to_string()
name != "X-Bunq-Server-Signature" && name |> String.starts_with?("X-Bunq-")
end)
|> header_signature_string()
signature_header =
headers |> Enum.find(fn(header) -> elem(header, 0) == "X-Bunq-Server-Signature" end)
if signature_header do
signature =
signature_header
|> elem(1)
|> :base64.decode()
verified = "#{status}\n#{headers_string}\n\n#{body}"
|> :public_key.verify(:sha256, signature, server_public_key(client))
if verified do
{:ok, status, headers, body}
else
{:error, "Could not verify response signature. Check that you have the correct server public key."}
end
else
{:ok, status, headers, body}
end
end
defp process_response_json({status, headers, body}) do
with {:ok, decoded_body} <- Poison.decode(body), do: {:ok, status, headers, decoded_body}
end
defp server_public_key(client) do
client.server_public_key
|> :public_key.pem_decode()
|> List.first()
|> :public_key.pem_entry_decode()
end
def add_installation_to_client(client, description \\ "Elixir Server") do
private_key = generate_private_key()
public_key = public_key_pem_from_private_key(private_key)
new_client = %{client | client_public_key: public_key, client_private_key: private_key}
{:ok, installation_resp} = %Bunck.Installation.Post{} |> Bunck.request(new_client)
server_public_key =
installation_resp.body
|> Map.get("Response")
|> Enum.find(fn
%{"ServerPublicKey" => _} -> true
_ -> false
end)
|> Map.get("ServerPublicKey") |> Map.get("server_public_key")
installation_token =
installation_resp.body
|> Map.get("Response")
|> Enum.find(fn
%{"Token" => _} -> true
_ -> false
end)
|> Map.get("Token") |> Map.get("token")
new_new_client = %{new_client | installation_token: installation_token, server_public_key: server_public_key}
%Bunck.DeviceServer.Post{description: description} |> Bunck.request(new_new_client)
new_new_client
end
def add_session_to_client(client) do
{:ok, session_resp} = %Bunck.SessionServer.Post{secret: client.api_key} |> Bunck.request(client)
session_token =
session_resp.body
|> Map.get("Response")
|> Enum.find(fn
%{"Token" => _} -> true
_ -> false
end)
|> Map.get("Token") |> Map.get("token")
%{client | session_token: session_token}
end
defp generate_private_key do
:public_key.generate_key({:rsa, 2048, 65537})
end
defp public_key_pem_from_private_key(private_key) do
pubkey = {:RSAPublicKey, elem(private_key, 2), elem(private_key, 3)}
pem_entry = :public_key.pem_entry_encode(:SubjectPublicKeyInfo, pubkey)
:public_key.pem_encode([pem_entry])
end
defmodule DeviceServer do
def start_link do
Agent.start_link(fn() ->
%Bunck.Client{api_key: Application.get_env(Bunck, :api_key)} |> Bunck.add_installation_to_client()
end, name: __MODULE__)
end
def get_session_client do
Agent.get(__MODULE__, fn(client) -> client end)
|> Bunck.add_session_to_client()
end
end
end