gose/key

Deprecated: use the gose module instead.

Re-exports the key API from gose for the v2.x migration window. The module will be removed in v3.0. New code should import gose directly.

Constructors of KeyUse, KeyOp, Alg, and KeyType are not re-exported (Gleam type aliases re-export the type but not its constructors). Callers that reference those constructors must update to gose.Signing, gose.SigningAlg(_), and so on. See docs/MIGRATION.md for the full list.

Types

Alg

</>

Deprecated: use gose.Alg (constructors must be re-imported: gose.SigningAlg, gose.KeyEncryptionAlg, gose.ContentAlg)

pub type Alg =
  gose.Alg

Key

</>

Deprecated: use gose.Key

pub type Key(kid) =
  gose.Key(kid)

KeyOp

</>

Deprecated: use gose.KeyOp (constructors must be re-imported)

pub type KeyOp =
  gose.KeyOp

KeyType

</>

Deprecated: use gose.KeyType

pub type KeyType =
  gose.KeyType

KeyUse

</>

Deprecated: use gose.KeyUse (constructors must be re-imported: gose.Signing, gose.Encrypting)

pub type KeyUse =
  gose.KeyUse

Values

alg

</>

pub fn alg(key: gose.Key(kid)) -> Result(gose.Alg, Nil)

Deprecated: use gose.alg

ec_curve

</>

pub fn ec_curve(
  key: gose.Key(kid),
) -> Result(ec.Curve, gose.GoseError)

Deprecated: use gose.ec_curve

ec_public_key

</>

pub fn ec_public_key(
  key: gose.Key(kid),
) -> Result(ec.PublicKey, gose.GoseError)

Deprecated: use gose.ec_public_key

ec_public_key_coordinates

</>

pub fn ec_public_key_coordinates(
  key: gose.Key(kid),
) -> Result(#(BitArray, BitArray), gose.GoseError)

Deprecated: use gose.ec_public_key_coordinates

ec_public_key_from_coordinates

</>

pub fn ec_public_key_from_coordinates(
  curve: ec.Curve,
  x x: BitArray,
  y y: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.ec_public_key_from_coordinates

eddsa_curve

</>

pub fn eddsa_curve(
  key: gose.Key(kid),
) -> Result(eddsa.Curve, gose.GoseError)

Deprecated: use gose.eddsa_curve

eddsa_public_key

</>

pub fn eddsa_public_key(
  key: gose.Key(kid),
) -> Result(eddsa.PublicKey, gose.GoseError)

Deprecated: use gose.eddsa_public_key

from_der

</>

pub fn from_der(
  der: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_der

from_eddsa_bits

</>

pub fn from_eddsa_bits(
  curve: eddsa.Curve,
  private_bits private_bits: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_eddsa_bits

from_eddsa_public_bits

</>

pub fn from_eddsa_public_bits(
  curve: eddsa.Curve,
  public_bits public_bits: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_eddsa_public_bits

from_octet_bits

</>

pub fn from_octet_bits(
  secret: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_octet_bits

from_pem

</>

pub fn from_pem(
  pem: String,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_pem

from_xdh_bits

</>

pub fn from_xdh_bits(
  curve: xdh.Curve,
  private_bits private_bits: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_xdh_bits

from_xdh_public_bits

</>

pub fn from_xdh_public_bits(
  curve: xdh.Curve,
  public_bits public_bits: BitArray,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.from_xdh_public_bits

generate_aes_kw_key

</>

pub fn generate_aes_kw_key(
  size: gose.AesKeySize,
) -> gose.Key(kid)

Deprecated: use gose.generate_aes_kw_key

generate_chacha20_kw_key

</>

pub fn generate_chacha20_kw_key() -> gose.Key(kid)

Deprecated: use gose.generate_chacha20_kw_key

generate_ec

</>

pub fn generate_ec(curve: ec.Curve) -> gose.Key(kid)

Deprecated: use gose.generate_ec

generate_eddsa

</>

pub fn generate_eddsa(curve: eddsa.Curve) -> gose.Key(kid)

Deprecated: use gose.generate_eddsa

generate_enc_key

</>

pub fn generate_enc_key(enc: gose.ContentAlg) -> gose.Key(kid)

Deprecated: use gose.generate_enc_key

generate_hmac_key

</>

pub fn generate_hmac_key(alg: gose.HmacAlg) -> gose.Key(kid)

Deprecated: use gose.generate_hmac_key

generate_rsa

</>

pub fn generate_rsa(
  bits: Int,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.generate_rsa

generate_xdh

</>

pub fn generate_xdh(curve: xdh.Curve) -> gose.Key(kid)

Deprecated: use gose.generate_xdh

key_ops

</>

pub fn key_ops(
  key: gose.Key(kid),
) -> Result(List(gose.KeyOp), Nil)

Deprecated: use gose.key_ops

key_type

</>

pub fn key_type(key: gose.Key(kid)) -> gose.KeyType

Deprecated: use gose.key_type

key_use

</>

pub fn key_use(key: gose.Key(kid)) -> Result(gose.KeyUse, Nil)

Deprecated: use gose.key_use

kid

</>

pub fn kid(key: gose.Key(kid)) -> Result(kid, Nil)

Deprecated: use gose.kid

octet_key_size

</>

pub fn octet_key_size(
  key: gose.Key(kid),
) -> Result(Int, gose.GoseError)

Deprecated: use gose.octet_key_size

public_key

</>

pub fn public_key(
  key: gose.Key(kid),
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.public_key

rsa_public_key

</>

pub fn rsa_public_key(
  key: gose.Key(kid),
) -> Result(rsa.PublicKey, gose.GoseError)

Deprecated: use gose.rsa_public_key

to_der

</>

pub fn to_der(
  key: gose.Key(kid),
) -> Result(BitArray, gose.GoseError)

Deprecated: use gose.to_der

to_octet_bits

</>

pub fn to_octet_bits(
  key: gose.Key(kid),
) -> Result(BitArray, gose.GoseError)

Deprecated: use gose.to_octet_bits

to_pem

</>

pub fn to_pem(
  key: gose.Key(kid),
) -> Result(String, gose.GoseError)

Deprecated: use gose.to_pem

with_alg

</>

pub fn with_alg(
  key: gose.Key(kid),
  alg: gose.Alg,
) -> gose.Key(kid)

Deprecated: use gose.with_alg

with_key_ops

</>

pub fn with_key_ops(
  key: gose.Key(kid),
  ops: List(gose.KeyOp),
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.with_key_ops

with_key_use

</>

pub fn with_key_use(
  key: gose.Key(kid),
  use_: gose.KeyUse,
) -> Result(gose.Key(kid), gose.GoseError)

Deprecated: use gose.with_key_use

with_kid

</>

pub fn with_kid(
  key: gose.Key(a),
  kid: String,
) -> gose.Key(String)

Deprecated: use gose.with_kid

with_kid_bits

</>

pub fn with_kid_bits(
  key: gose.Key(a),
  kid: BitArray,
) -> gose.Key(BitArray)

Deprecated: use gose.with_kid_bits

xdh_curve

</>

pub fn xdh_curve(
  key: gose.Key(kid),
) -> Result(xdh.Curve, gose.GoseError)

Deprecated: use gose.xdh_curve

xdh_public_key

</>

pub fn xdh_public_key(
  key: gose.Key(kid),
) -> Result(xdh.PublicKey, gose.GoseError)

Deprecated: use gose.xdh_public_key