# OtpPki v0.0.1 (Pre-Alpha)

**This is a pre-alpha release and the package is not yet functional, contains no stable API, and  is not ready for any use.**

## Vision & Architecture

The Erlang `:public_key` application is the cornerstone of PKI operations on the BEAM; however, it is complex, cumbersome to use from Elixir, and subject to change between OTP releases.

Any upstream change to the records and constants used in the Erlang public_key app triggers an update for the otp_pki package. Thus, the release of the otp_pki package follows the release of public_key used in the latest version of Erlang OTP.

`otp_pki` provides two API layers for developers to choose between complete control or ease of use:

1.  **Low-Level API:** A one-to-one mapping of all Erlang records and OID constants.

2.  **High-Level API:** A set of handwritten, user-friendly helper functions to offer an ergonomic interface for most application developer use-cases.

## Installation

To track the development of this package, add `otp_pki` to your list of dependencies in `mix.exs`:

```
Def deps do
  [
    {:otp_pki, "~> 0.0.1"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/otp_pki>.