Packages
bandit
0.6.5
1.12.1
1.12.0
1.11.1
1.11.0
1.10.4
1.10.3
1.10.2
1.10.1
1.10.0
retired
1.9.0
1.8.0
1.7.0
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.2
1.4.1
1.4.0
1.3.0
1.2.3
1.2.2
1.2.1
1.2.0
1.1.3
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-pre.18
1.0.0-pre.17
1.0.0-pre.16
1.0.0-pre.15
1.0.0-pre.14
1.0.0-pre.13
1.0.0-pre.12
1.0.0-pre.11
1.0.0-pre.10
1.0.0-pre.9
1.0.0-pre.8
1.0.0-pre.7
1.0.0-pre.6
1.0.0-pre.5
1.0.0-pre.4
1.0.0-pre.3
1.0.0-pre.2
1.0.0-pre.1
0.7.7
0.7.6
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.11
0.6.10
0.6.9
0.6.8
0.6.7
0.6.6
0.6.5
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.11
0.5.10
0.5.9
0.5.8
0.5.7
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.10
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.2.3
0.2.2
0.2.1
0.2.0
0.1.1
0.1.0
A pure-Elixir HTTP server built for Plug & WebSock apps
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/bandit/http1/adapter.ex
defmodule Bandit.HTTP1.Adapter do
@moduledoc false
@type state :: :new | :headers_read | :no_body | :body_read | :sent | :chunking_out
@behaviour Plug.Conn.Adapter
defstruct state: :new,
socket: nil,
buffer: <<>>,
body_remaining: nil,
body_encoding: nil,
version: nil,
keepalive: false,
upgrade: nil
# credo:disable-for-this-file Credo.Check.Design.AliasUsage
################
# Header Reading
################
def read_headers(req) do
with {:ok, headers, method, request_target, %__MODULE__{} = req} <- do_read_headers(req),
{:ok, body_size} <- Bandit.Headers.get_content_length(headers) do
body_encoding = Bandit.Headers.get_header(headers, "transfer-encoding")
connection = Bandit.Headers.get_header(headers, "connection")
keepalive = should_keepalive?(req.version, connection)
case {body_size, body_encoding} do
{nil, nil} ->
{:ok, headers, method, request_target, %{req | state: :no_body, keepalive: keepalive}}
{body_size, nil} ->
body_remaining = body_size - byte_size(req.buffer)
{:ok, headers, method, request_target,
%{req | state: :headers_read, body_remaining: body_remaining, keepalive: keepalive}}
{nil, body_encoding} ->
{:ok, headers, method, request_target,
%{req | state: :headers_read, body_encoding: body_encoding, keepalive: keepalive}}
{_content_length, _body_encoding} ->
{:error,
"request cannot contain 'content-length' and 'transfer-encoding' (RFC9112ยง6.3.3)"}
end
end
end
@dialyzer {:no_improper_lists, do_read_headers: 5}
defp do_read_headers(
req,
type \\ :http_bin,
headers \\ [],
method \\ nil,
request_target \\ nil
) do
case :erlang.decode_packet(type, req.buffer, []) do
{:more, _len} ->
with {:ok, iodata} <- read(req.socket, 0) do
# decode_packet expects a binary, so convert it to one
req = %{req | buffer: IO.iodata_to_binary([req.buffer | iodata])}
do_read_headers(req, type, headers, method, request_target)
end
{:ok, {:http_request, method, request_target, version}, rest} ->
with {:ok, version} <- get_version(version),
{:ok, request_target} <- resolve_request_target(request_target),
req <- %{req | buffer: rest, version: version} do
do_read_headers(req, :httph_bin, headers, method, request_target)
end
{:ok, {:http_header, _, header, _, value}, rest} ->
req = %{req | buffer: rest}
headers = [{header |> to_string() |> String.downcase(:ascii), value} | headers]
do_read_headers(req, :httph_bin, headers, to_string(method), request_target)
{:ok, :http_eoh, rest} ->
{:ok, headers, method, request_target, %{req | state: :headers_read, buffer: rest}}
{:ok, {:http_error, reason}, _rest} ->
{:error, reason}
{:error, reason} ->
{:error, reason}
end
end
# `close` & `keep-alive` always means what they say, otherwise keepalive if we're on HTTP/1.1
defp should_keepalive?(_, "close"), do: false
defp should_keepalive?(_, "keep-alive"), do: true
defp should_keepalive?(:"HTTP/1.1", _), do: true
defp should_keepalive?(_, _), do: false
defp get_version({1, 1}), do: {:ok, :"HTTP/1.1"}
defp get_version({1, 0}), do: {:ok, :"HTTP/1.0"}
defp get_version(other), do: {:error, "invalid HTTP version: #{inspect(other)}"}
# Unwrap different request_targets returned by :erlang.decode_packet/3
defp resolve_request_target({:abs_path, path}), do: {:ok, {nil, nil, nil, path}}
defp resolve_request_target({:absoluteURI, scheme, host, :undefined, path}),
do: {:ok, {to_string(scheme), host, nil, path}}
defp resolve_request_target({:absoluteURI, scheme, host, port, path}),
do: {:ok, {to_string(scheme), host, port, path}}
defp resolve_request_target(:*), do: {:ok, {nil, nil, nil, :*}}
defp resolve_request_target({:scheme, _scheme, _path}),
do: {:error, "schemeURI is not supported"}
defp resolve_request_target(_request_target),
do: {:error, "Unsupported request target (RFC9112ยง3.2)"}
##############
# Body Reading
##############
@impl Plug.Conn.Adapter
def read_req_body(%__MODULE__{state: :no_body} = req, _opts), do: {:ok, <<>>, req}
def read_req_body(
%__MODULE__{state: :headers_read, buffer: buffer, body_remaining: 0} = req,
_opts
) do
{:ok, buffer, %{req | state: :body_read, buffer: <<>>}}
end
@dialyzer {:no_improper_lists, read_req_body: 2}
def read_req_body(
%__MODULE__{state: :headers_read, body_remaining: body_remaining, buffer: buffer} = req,
opts
)
when is_number(body_remaining) do
max_desired_bytes = Keyword.get(opts, :length, 8_000_000)
if byte_size(buffer) >= max_desired_bytes do
<<to_return::binary-size(max_desired_bytes), rest::binary>> = buffer
{:more, to_return, %{req | buffer: rest}}
else
to_read = min(body_remaining, max_desired_bytes - byte_size(buffer))
with {:ok, iodata} <- read(req.socket, to_read, opts) do
result = IO.iodata_to_binary([buffer | iodata])
body_remaining = body_remaining - IO.iodata_length(iodata)
if body_remaining > 0 do
{:more, result, %{req | buffer: <<>>, body_remaining: body_remaining}}
else
{:ok, result, %{req | state: :body_read, buffer: <<>>, body_remaining: 0}}
end
end
end
end
def read_req_body(%__MODULE__{state: :headers_read, body_encoding: "chunked"} = req, opts) do
with {:ok, body, req} <- do_read_chunk(req, <<>>, opts) do
{:ok, IO.iodata_to_binary(body), req}
end
end
def read_req_body(%__MODULE__{state: :headers_read, body_encoding: body_encoding}, _opts)
when not is_nil(body_encoding) do
{:error, :unsupported_transfer_encoding}
end
def read_req_body(%__MODULE__{}, _opts), do: raise(Bandit.BodyAlreadyReadError)
@dialyzer {:no_improper_lists, do_read_chunk: 3}
defp do_read_chunk(%__MODULE__{buffer: buffer} = req, body, opts) do
case :binary.split(buffer, "\r\n") do
["0", _] ->
{:ok, IO.iodata_to_binary(body), req}
[chunk_size, rest] ->
chunk_size = String.to_integer(chunk_size, 16)
case rest do
<<next_chunk::binary-size(chunk_size), ?\r, ?\n, rest::binary>> ->
do_read_chunk(%{req | buffer: rest}, [body, next_chunk], opts)
_ ->
with {:ok, iodata} <- read(req.socket, chunk_size - byte_size(rest), opts) do
req = %{req | buffer: IO.iodata_to_binary([req.buffer | iodata])}
do_read_chunk(req, body, opts)
end
end
_ ->
with {:ok, iodata} <- read(req.socket, 0, opts) do
req = %{req | buffer: IO.iodata_to_binary([req.buffer | iodata])}
do_read_chunk(req, body, opts)
end
end
end
##################
# Internal Reading
##################
@dialyzer {:no_improper_lists, read: 5}
defp read(socket, to_read, opts \\ [], bytes_read \\ 0, already_read \\ []) do
read_size = min(to_read, Keyword.get(opts, :read_length, 1_000_000))
read_timeout = Keyword.get(opts, :read_timeout)
with {:ok, chunk} <- ThousandIsland.Socket.recv(socket, read_size, read_timeout) do
remaining_bytes = to_read - byte_size(chunk)
bytes_read = bytes_read + byte_size(chunk)
if remaining_bytes > 0 do
read(socket, remaining_bytes, opts, bytes_read, [already_read | chunk])
else
{:ok, [already_read | chunk]}
end
end
end
##################
# Response Sending
##################
@impl Plug.Conn.Adapter
def send_resp(%__MODULE__{state: :sent}, _, _, _), do: raise(Plug.Conn.AlreadySentError)
def send_resp(%__MODULE__{state: :chunking_out}, _, _, _), do: raise(Plug.Conn.AlreadySentError)
def send_resp(%__MODULE__{socket: socket, version: version} = req, status, headers, response) do
headers =
if add_content_length?(status) do
[{"content-length", response |> IO.iodata_length() |> to_string()} | headers]
else
headers
end
header_io_data = response_header(version, status, headers)
ThousandIsland.Socket.send(socket, [header_io_data, response])
{:ok, nil, %{req | state: :sent}}
end
# Per RFC2616ยง4.{3,4}
defp add_content_length?(status) when status in 100..199, do: false
defp add_content_length?(204), do: false
defp add_content_length?(304), do: false
defp add_content_length?(_), do: true
@impl Plug.Conn.Adapter
def send_file(
%__MODULE__{socket: socket, version: version} = req,
status,
headers,
path,
offset,
length
) do
%File.Stat{type: :regular, size: size} = File.stat!(path)
length =
cond do
length == :all -> size - offset
is_integer(length) -> length
end
if offset + length <= size do
headers = [{"content-length", length |> to_string()} | headers]
ThousandIsland.Socket.send(socket, response_header(version, status, headers))
ThousandIsland.Socket.sendfile(socket, path, offset, length)
{:ok, nil, %{req | state: :sent}}
else
{:error,
"Cannot read #{length} bytes starting at #{offset} as #{path} is only #{size} octets in length"}
end
end
@impl Plug.Conn.Adapter
def send_chunked(%__MODULE__{socket: socket, version: version} = req, status, headers) do
headers = [{"transfer-encoding", "chunked"} | headers]
ThousandIsland.Socket.send(socket, response_header(version, status, headers))
{:ok, nil, %{req | state: :chunking_out}}
end
@impl Plug.Conn.Adapter
def chunk(%__MODULE__{socket: socket}, chunk) do
byte_size = chunk |> IO.iodata_length() |> Integer.to_string(16)
ThousandIsland.Socket.send(socket, [byte_size, "\r\n", chunk, "\r\n"])
:ok
end
defp response_header(nil, status, headers), do: response_header("HTTP/1.0", status, headers)
defp response_header(version, status, headers) do
headers =
if is_nil(Bandit.Headers.get_header(headers, "date")) do
[Bandit.Clock.date_header() | headers]
else
headers
end
[
to_string(version),
" ",
to_string(status),
" ",
reason_for_status(status),
"\r\n",
Enum.map(headers, fn {k, v} -> [k, ": ", v, "\r\n"] end),
"\r\n"
]
end
@impl Plug.Conn.Adapter
def inform(_req, _status, _headers), do: {:error, :not_supported}
@impl Plug.Conn.Adapter
def upgrade(req, :websocket, opts), do: {:ok, %{req | upgrade: {:websocket, opts}}}
def upgrade(_req, _upgrade, _opts), do: {:error, :not_supported}
@impl Plug.Conn.Adapter
def push(_req, _path, _headers), do: {:error, :not_supported}
@impl Plug.Conn.Adapter
def get_peer_data(%__MODULE__{socket: socket}), do: ThousandIsland.Socket.peer_info(socket)
def get_local_data(%__MODULE__{socket: socket}), do: ThousandIsland.Socket.local_info(socket)
def secure?(%__MODULE__{socket: socket}), do: ThousandIsland.Socket.secure?(socket)
@impl Plug.Conn.Adapter
def get_http_protocol(%__MODULE__{version: version}), do: version
def keepalive?(%__MODULE__{keepalive: keepalive}), do: keepalive
response_reasons = %{
100 => "Continue",
101 => "Switching Protocols",
200 => "OK",
201 => "Created",
202 => "Accepted",
203 => "Non-Authoritative Information",
204 => "No Content",
205 => "Reset Content",
206 => "Partial Content",
300 => "Multiple Choices",
301 => "Moved Permanently",
302 => "Found",
303 => "See Other",
304 => "Not Modified",
305 => "Use Proxy",
307 => "Temporary Redirect",
400 => "Bad Request",
401 => "Unauthorized",
402 => "Payment Required",
403 => "Forbidden",
404 => "Not Found",
405 => "Method Not Allowed",
406 => "Not Acceptable",
407 => "Proxy Authentication Required",
408 => "Request Time-out",
409 => "Conflict",
410 => "Gone",
411 => "Length Required",
412 => "Precondition Failed",
413 => "Request Entity Too Large",
414 => "Request-URI Too Large",
415 => "Unsupported Media Type",
416 => "Requested range not satisfiable",
417 => "Expectation Failed",
500 => "Internal Server Error",
501 => "Not Implemented",
502 => "Bad Gateway",
503 => "Service Unavailable",
504 => "Gateway Time-out",
505 => "HTTP Version not supported"
}
for {code, reason} <- response_reasons do
defp reason_for_status(unquote(code)), do: unquote(reason)
end
defp reason_for_status(_), do: "Unknown Status Code"
end