IABSD.fr/src/lib/libfido2/man/eddsa_pk_new.3

Branch : - branch - master - tag -

• Show log

  Commit

• Author : djm
  Date : 2020-02-07 00:57:49
  Hash : 32a20e26
  Message : update to upstream libfido2 780ad3c25 (20120123) install manual pages crank major feedback & ok jmc@ and naddy@

• lib/libfido2/man/eddsa_pk_new.3

• .\" Copyright (c) 2019 Yubico AB. All rights reserved.
  .\" Use of this source code is governed by a BSD-style
  .\" license that can be found in the LICENSE file.
  .\"
  .Dd $Mdocdate: February 7 2020 $
  .Dt EDDSA_PK_NEW 3
  .Os
  .Sh NAME
  .Nm eddsa_pk_new ,
  .Nm eddsa_pk_free ,
  .Nm eddsa_pk_from_EVP_PKEY ,
  .Nm eddsa_pk_from_ptr ,
  .Nm eddsa_pk_to_EVP_PKEY
  .Nd FIDO 2 COSE EDDSA API
  .Sh SYNOPSIS
  .In openssl/evp.h
  .In fido/eddsa.h
  .Ft eddsa_pk_t *
  .Fn eddsa_pk_new "void"
  .Ft void
  .Fn eddsa_pk_free "eddsa_pk_t **pkp"
  .Ft int
  .Fn eddsa_pk_from_EVP_PKEY "eddsa_pk_t *pk" "const EVP_PKEY *pkey"
  .Ft int
  .Fn eddsa_pk_from_ptr "eddsa_pk_t *pk" "const void *ptr" "size_t len"
  .Ft EVP_PKEY *
  .Fn eddsa_pk_to_EVP_PKEY "const eddsa_pk_t *pk"
  .Sh DESCRIPTION
  EDDSA is the name given in the CBOR Object Signing and Encryption
  (COSE) RFC to EDDSA over Curve25519 with SHA-512.
  The COSE EDDSA API of
  .Em libfido2
  is an auxiliary API with routines to convert between the different
  EDDSA public key types used in
  .Em libfido2
  and
  .Em OpenSSL .
  .Pp
  In
  .Em libfido2 ,
  EDDSA public keys are abstracted by the
  .Vt eddsa_pk_t
  type.
  .Pp
  The
  .Fn eddsa_pk_new
  function returns a pointer to a newly allocated, empty
  .Vt eddsa_pk_t
  type.
  If memory cannot be allocated, NULL is returned.
  .Pp
  The
  .Fn eddsa_pk_free
  function releases the memory backing
  .Fa *pkp ,
  where
  .Fa *pkp
  must have been previously allocated by
  .Fn eddsa_pk_new .
  On return,
  .Fa *pkp
  is set to NULL.
  Either
  .Fa pkp
  or
  .Fa *pkp
  may be NULL, in which case
  .Fn eddsa_pk_free
  is a NOP.
  .Pp
  The
  .Fn eddsa_pk_from_EVP_PKEY
  function fills
  .Fa pk
  with the contents of
  .Fa pkey .
  No references to
  .Fa pkey
  are kept.
  .Pp
  The
  .Fn eddsa_pk_from_ptr
  function fills
  .Fa pk
  with the contents of
  .Fa ptr ,
  where
  .Fa ptr
  points to
  .Fa len
  bytes.
  No references to
  .Fa ptr
  are kept.
  .Pp
  The
  .Fn eddsa_pk_to_EVP_PKEY
  function converts
  .Fa pk
  to a newly allocated
  .Fa EVP_PKEY
  type with a reference count of 1.
  No internal references to the returned pointer are kept.
  If an error occurs,
  .Fn eddsa_pk_to_EVP_PKEY
  returns NULL.
  .Sh RETURN VALUES
  The
  .Fn eddsa_pk_from_EC_KEY
  and
  .Fn eddsa_pk_from_ptr
  functions return
  .Dv FIDO_OK
  on success.
  On error, a different error code defined in
  .In fido/err.h
  is returned.
  .Sh SEE ALSO
  .Xr es256_pk_new 3 ,
  .Xr fido_assert_verify 3 ,
  .Xr fido_cred_pubkey_ptr 3 ,
  .Xr rs256_pk_new 3