%% -*- mode: erlang; tab-width: 4; indent-tabs-mode: 1; st-rulers: [70] -*-
%% vim: ts=4 sw=4 ft=erlang noet
%%%-------------------------------------------------------------------
%%% @author Andrew Bennett <potatosaladx@gmail.com>
%%% @copyright 2014-2022, Andrew Bennett
%%% @doc
%%%
%%% @end
%%% Created : 15 Jan 2016 by Andrew Bennett <potatosaladx@gmail.com>
%%%-------------------------------------------------------------------
-module(jose_jwk_kty_okp_x448).
-behaviour(jose_jwk).
-behaviour(jose_jwk_kty).
-behaviour(jose_jwk_use_enc).
-include("jose_public_key.hrl").
%% jose_jwk callbacks
-export([from_map/1]).
-export([to_key/1]).
-export([to_map/2]).
-export([to_public_map/2]).
-export([to_thumbprint_map/2]).
%% jose_jwk_kty callbacks
-export([generate_key/1]).
-export([generate_key/2]).
-export([key_encryptor/3]).
%% jose_jwk_use_enc callbacks
-export([block_encryptor/2]).
-export([derive_key/2]).
%% API
-export([from_der/1]).
-export([from_der/2]).
-export([from_key/1]).
-export([from_okp/1]).
-export([from_openssh_key/1]).
-export([from_pem/1]).
-export([from_pem/2]).
-export([to_der/1]).
-export([to_der/2]).
-export([to_okp/1]).
-export([to_openssh_key/2]).
-export([to_pem/1]).
-export([to_pem/2]).
%% Macros
-define(crv, <<"X448">>).
-define(secretbytes, 56).
-define(publickeybytes, 56).
-define(secretkeybytes, 112).
%% Types
-type publickey() :: << _:448 >>.
-type secretkey() :: << _:896 >>.
-type key() :: publickey() | secretkey().
-export_type([key/0]).
%%====================================================================
%% jose_jwk callbacks
%%====================================================================
from_map(F = #{ <<"kty">> := <<"OKP">>, <<"crv">> := ?crv, <<"d">> := D, <<"x">> := X }) ->
<< Secret:?secretbytes/binary >> = jose_jwa_base64url:decode(D),
<< PK:?publickeybytes/binary >> = jose_jwa_base64url:decode(X),
SK = << Secret/binary, PK/binary >>,
{SK, maps:without([<<"crv">>, <<"d">>, <<"kty">>, <<"x">>], F)};
from_map(F = #{ <<"kty">> := <<"OKP">>, <<"crv">> := ?crv, <<"x">> := X }) ->
<< PK:?publickeybytes/binary >> = jose_jwa_base64url:decode(X),
{PK, maps:without([<<"crv">>, <<"kty">>, <<"x">>], F)}.
to_key(<< PublicKey:?publickeybytes/binary >>) ->
#'jose_X448PublicKey'{ publicKey = PublicKey };
to_key(<< PrivateKey:?secretbytes/binary, PublicKey:?publickeybytes/binary >>) ->
#'jose_X448PrivateKey'{
publicKey = #'jose_X448PublicKey'{ publicKey = PublicKey },
privateKey = PrivateKey
}.
to_map(PK = << _:?publickeybytes/binary >>, F) ->
F#{
<<"crv">> => ?crv,
<<"kty">> => <<"OKP">>,
<<"x">> => jose_jwa_base64url:encode(PK)
};
to_map(<< Secret:?secretbytes/binary, PK:?publickeybytes/binary >>, F) ->
F#{
<<"crv">> => ?crv,
<<"d">> => jose_jwa_base64url:encode(Secret),
<<"kty">> => <<"OKP">>,
<<"x">> => jose_jwa_base64url:encode(PK)
}.
to_public_map(PK = << _:?publickeybytes/binary >>, F) ->
to_map(PK, F);
to_public_map(<< _:?secretbytes/binary, PK:?publickeybytes/binary >>, F) ->
to_public_map(PK, F).
to_thumbprint_map(K, F) ->
maps:with([<<"crv">>, <<"kty">>, <<"x">>], to_public_map(K, F)).
%%====================================================================
%% jose_jwk_kty callbacks
%%====================================================================
generate_key(Seed = << _:?secretbytes/binary >>) ->
{PK, SK} = jose_curve448:x448_keypair(Seed),
{<< SK/binary, PK/binary >>, #{}};
generate_key({okp, 'X448', Seed = << _:?secretbytes/binary >>}) ->
generate_key(Seed);
generate_key({okp, 'X448'}) ->
{PK, SK} = jose_curve448:x448_keypair(),
{<< SK/binary, PK/binary >>, #{}}.
generate_key(KTY, Fields)
when is_binary(KTY)
andalso (byte_size(KTY) =:= ?publickeybytes
orelse byte_size(KTY) =:= ?secretkeybytes) ->
{NewKTY, OtherFields} = generate_key({okp, 'X448'}),
{NewKTY, maps:merge(maps:remove(<<"kid">>, Fields), OtherFields)}.
key_encryptor(KTY, Fields, Key) ->
jose_jwk_kty:key_encryptor(KTY, Fields, Key).
%%====================================================================
%% jose_jwk_use_enc callbacks
%%====================================================================
block_encryptor(_KTY, Fields=#{ <<"alg">> := ALG, <<"enc">> := ENC, <<"use">> := <<"enc">> }) ->
Folder = fun
(K, V, F)
when K =:= <<"apu">>
orelse K =:= <<"apv">>
orelse K =:= <<"epk">>
orelse K =:= <<"skid">> ->
maps:put(K, V, F);
(_K, _V, F) ->
F
end,
maps:fold(Folder, #{
<<"alg">> => ALG,
<<"enc">> => ENC
}, Fields);
block_encryptor(KTY, Fields=#{ <<"alg">> := <<"ECDH-1PU", _/binary>> }) ->
block_encryptor(KTY, maps:merge(Fields, #{
<<"enc">> => case jose_jwa:is_block_cipher_supported({aes_gcm, 128}) of
false -> <<"A128CBC-HS256">>;
true -> <<"A128GCM">>
end,
<<"use">> => <<"enc">>
}));
block_encryptor(KTY, Fields=#{ <<"alg">> := <<"ECDH-SS", _/binary>> }) ->
block_encryptor(KTY, maps:merge(Fields, #{
<<"enc">> => case jose_jwa:is_block_cipher_supported({aes_gcm, 128}) of
false -> <<"A128CBC-HS256">>;
true -> <<"A128GCM">>
end,
<<"use">> => <<"enc">>
}));
block_encryptor(KTY, Fields) ->
block_encryptor(KTY, maps:merge(Fields, #{
<<"alg">> => <<"ECDH-ES">>,
<<"enc">> => case jose_jwa:is_block_cipher_supported({aes_gcm, 128}) of
false -> <<"A128CBC-HS256">>;
true -> <<"A128GCM">>
end,
<<"use">> => <<"enc">>
})).
derive_key(<< _:?secretbytes/binary, PK:?publickeybytes/binary >>, SK = << _:?secretkeybytes/binary >>) ->
derive_key(PK, SK);
derive_key(PK = << _:?publickeybytes/binary >>, << Secret:?secretbytes/binary, _:?publickeybytes/binary >>) ->
jose_curve448:x448_shared_secret(Secret, PK).
%%====================================================================
%% API functions
%%====================================================================
from_der(DERBinary) when is_binary(DERBinary) ->
case jose_jwk_der:from_binary(DERBinary) of
{?MODULE, {Key, Fields}} ->
{Key, Fields}
end.
from_der(Password, DERBinary) when is_binary(DERBinary) ->
case jose_jwk_der:from_binary(Password, DERBinary) of
{?MODULE, {Key, Fields}} ->
{Key, Fields}
end.
from_key(#'jose_X448PrivateKey'{publicKey=#'jose_X448PublicKey'{publicKey=Public}, privateKey=Secret}) ->
{<< Secret/binary, Public/binary >>, #{}};
from_key(#'jose_X448PublicKey'{publicKey=Public}) ->
{Public, #{}}.
from_okp({'X448', SK = << Secret:?secretbytes/binary, PK:?publickeybytes/binary >>}) ->
case jose_curve448:x448_secret_to_public(Secret) of
PK ->
{SK, #{}};
_ ->
erlang:error(badarg)
end;
from_okp({'X448', PK = << _:?publickeybytes/binary >>}) ->
{PK, #{}}.
from_openssh_key({<<"ssh-x448">>, _PK, SK, Comment}) ->
{KTY, OtherFields} = from_okp({'X448', SK}),
case Comment of
<<>> ->
{KTY, OtherFields};
_ ->
{KTY, maps:merge(#{ <<"kid">> => Comment }, OtherFields)}
end.
from_pem(PEMBinary) when is_binary(PEMBinary) ->
case jose_jwk_pem:from_binary(PEMBinary) of
{?MODULE, {Key, Fields}} ->
{Key, Fields};
PEMError ->
PEMError
end.
from_pem(Password, PEMBinary) when is_binary(PEMBinary) ->
case jose_jwk_pem:from_binary(Password, PEMBinary) of
{?MODULE, {Key, Fields}} ->
{Key, Fields};
PEMError ->
PEMError
end.
to_der(SK = << _:?secretkeybytes/binary >>) ->
X448PrivateKey = to_key(SK),
jose_public_key:der_encode('X448PrivateKey', X448PrivateKey);
to_der(PK = << _:?publickeybytes/binary >>) ->
X448PublicKey = to_key(PK),
jose_public_key:der_encode('X448PublicKey', X448PublicKey).
to_der(Password, SK = << _:?secretkeybytes/binary >>) ->
X448PrivateKey = to_key(SK),
jose_jwk_der:to_binary(Password, 'X448PrivateKey', X448PrivateKey);
to_der(Password, PK = << _:?publickeybytes/binary >>) ->
X448PublicKey = to_key(PK),
jose_jwk_der:to_binary(Password, 'X448PublicKey', X448PublicKey).
to_okp(SK = << _:?secretkeybytes/binary >>) ->
{'X448', SK};
to_okp(PK = << _:?publickeybytes/binary >>) ->
{'X448', PK}.
to_openssh_key(SK = << _:?secretbytes/binary, PK:?publickeybytes/binary >>, F) ->
Comment = maps:get(<<"kid">>, F, <<>>),
jose_jwk_openssh_key:to_binary([[{{<<"ssh-x448">>, PK}, {<<"ssh-x448">>, PK, SK, Comment}}]]).
to_pem(SK = << _:?secretkeybytes/binary >>) ->
X448PrivateKey = to_key(SK),
PEMEntry = jose_public_key:pem_entry_encode('X448PrivateKey', X448PrivateKey),
jose_public_key:pem_encode([PEMEntry]);
to_pem(PK = << _:?publickeybytes/binary >>) ->
X448PublicKey = to_key(PK),
PEMEntry = jose_public_key:pem_entry_encode('X448PublicKey', X448PublicKey),
jose_public_key:pem_encode([PEMEntry]).
to_pem(Password, SK = << _:?secretkeybytes/binary >>) ->
X448PrivateKey = to_key(SK),
jose_jwk_pem:to_binary(Password, 'PrivateKeyInfo', X448PrivateKey);
to_pem(Password, PK = << _:?publickeybytes/binary >>) ->
X448PublicKey = to_key(PK),
jose_jwk_pem:to_binary(Password, 'X448PublicKey', X448PublicKey).
%%%-------------------------------------------------------------------
%%% Internal functions
%%%-------------------------------------------------------------------