Module pkix

Behaviours: gen_server.

Data Types

bad_cert_error()

bad_cert_error() = {bad_cert, pos_integer(), bad_cert_reason()}

bad_cert_reason()

bad_cert_reason() = missing_priv_key | bad_der | bad_pem | empty | encrypted | unknown_key_algo | unknown_key_type | unexpected_eof | nested_pem

cert()

cert() = #'OTPCertificate'{}

cert_info()

cert_info() = #{files := [{filename(), line_num()}, ...], expiry := calendar:datetime(), domains := [binary()]}

certs_map()

certs_map() = #{cert() => [#pem{file = filename(), line = line_num(), der = binary()}]}

commit_option()

commit_option() = {cafile, file:filename_all()} | {validate, false | soft | hard} | {notify_before, [seconds()]} | {notify_fun, notify_fun()}

dirname()

dirname() = binary()

error_reason()

error_reason() = bad_cert_error() | invalid_cert_error() | io_error()

filename()

filename() = binary()

files_map()

files_map() = #{filename() => {calendar:datetime(), [cert()], [priv_key()]}}

invalid_cert_error()

invalid_cert_error() = {invalid_cert, pos_integer(), invalid_cert_reason()}

invalid_cert_reason()

invalid_cert_reason() = cert_expired | invalid_issuer | invalid_signature | name_not_permitted | missing_basic_constraint | invalid_key_usage | selfsigned_peer | unknown_ca | unused_priv_key

io_error()

io_error() = file:posix()

keys_map()

keys_map() = #{priv_key() => [#pem{file = filename(), line = line_num(), der = binary()}]}

line_num()

line_num() = pos_integer()

notify_event()

notify_event() = {cert_expired, cert(), cert_info()}

notify_fun()

notify_fun() = fun((notify_event()) -> any())

priv_key()

priv_key() = public_key:private_key()

seconds()

seconds() = non_neg_integer()

state()

state() = #state{files = files_map(), certs = certs_map(), keys = keys_map(), validate = false | soft | hard, dir = undefined | dirname(), cafile = undefined | filename(), timers = sets:set(), notify_fun = undefined | notify_fun()}

Function Index

add_file/1
code_change/3
commit/1
commit/2
current_datetime/0
del_file/1
extract_domains/1
format_error/1
get_cafile/0
get_cert_info/1
get_certfile/0
get_certfile/1
get_certfiles/0
get_expiration_date/1
handle_call/3
handle_cast/2
handle_info/2
init/1
is_pem_file/1
read_file/1
start/0
start_link/0
stop/0
terminate/2

Function Details

add_file/1

add_file(Path::file:filename_all()) -> ok | {error, bad_cert_error() | io_error()}

code_change/3

code_change(OldVsn::term() | {down, term()}, State::state(), Extra::term()) -> {ok, state()}

commit/1

commit(Dir::file:filename_all()) -> {ok, Errors::[{filename(), bad_cert_error() | invalid_cert_error() | io_error()}], Warnings::[{filename(), bad_cert_error() | invalid_cert_error()}], CAError::{filename(), bad_cert_error() | io_error()} | undefined} | {error, filename() | dirname(), io_error()}

commit/2

commit(Dir::file:filename_all(), Opts::[commit_option()]) -> {ok, Errors::[{filename(), bad_cert_error() | invalid_cert_error() | io_error()}], Warnings::[{filename(), bad_cert_error() | invalid_cert_error()}], CAError::{filename(), bad_cert_error() | io_error()} | undefined} | {error, filename() | dirname(), io_error()}

current_datetime/0

current_datetime() -> calendar:datetime()

del_file/1

del_file(Path::file:filename_all()) -> ok

extract_domains/1

extract_domains(Cert::cert()) -> [binary()]

format_error/1

format_error(Posix::bad_cert_error() | invalid_cert_error() | io_error()) -> string()

get_cafile/0

get_cafile() -> filename()

get_cert_info/1

get_cert_info(Cert::cert()) -> {ok, cert_info()} | error

get_certfile/0

get_certfile() -> {EC::filename() | undefined, RSA::filename() | undefined, DSA::filename() | undefined} | error

get_certfile/1

get_certfile(Domain::binary()) -> {EC::filename() | undefined, RSA::filename() | undefined, DSA::filename() | undefined} | error

get_certfiles/0

get_certfiles() -> [{binary(), [{filename(), ec | rsa | dsa}]}]

get_expiration_date/1

get_expiration_date(X1::cert()) -> calendar:datetime()

handle_call/3

handle_call(Request::term(), From::term(), State::state()) -> {reply, term(), state()} | {noreply, state()}

handle_cast/2

handle_cast(Msg::term(), State::state()) -> {noreply, state()}

handle_info/2

handle_info(Info::term(), State::state()) -> {noreply, state()}

init/1

init(X1::[]) -> {ok, state()}

is_pem_file/1

is_pem_file(Path::file:filename_all()) -> true | {false, bad_cert_error() | io_error()}

read_file/1

read_file(Path::file:filename_all()) -> {ok, #{cert() => [line_num()]}, #{priv_key() => [line_num()]}} | {error, bad_cert_error() | io_error()}

start/0

start() -> ok | {error, term()}

start_link/0

start_link() -> {ok, Pid::pid()} | {error, Error::{already_started, pid()}} | {error, Error::term()} | ignore

stop/0

stop() -> ok | {error, term()}

terminate/2

terminate(Reason::normal | shutdown | {shutdown, term()} | term(), State::state()) -> any()


Generated by EDoc