1RS256_PK_NEW(3)          BSD Library Functions Manual          RS256_PK_NEW(3)
2

NAME

4     rs256_pk_new, rs256_pk_free, rs256_pk_from_RSA, rs256_pk_from_ptr,
5     rs256_pk_to_EVP_PKEY — FIDO 2 COSE RS256 API
6

SYNOPSIS

8     #include <openssl/rsa.h>
9     #include <fido/rs256.h>
10
11     rs256_pk_t *
12     rs256_pk_new(void);
13
14     void
15     rs256_pk_free(rs256_pk_t **pkp);
16
17     int
18     rs256_pk_from_RSA(rs256_pk_t *pk, const RSA *rsa);
19
20     int
21     rs256_pk_from_ptr(rs256_pk_t *pk, const void *ptr, size_t len);
22
23     EVP_PKEY *
24     rs256_pk_to_EVP_PKEY(const rs256_pk_t *pk);
25

DESCRIPTION

27     RS256 is the name given in the CBOR Object Signing and Encryption (COSE)
28     RFC to PKCS#1.5 2048-bit RSA with SHA-256.  The COSE RS256 API of
29     libfido2 is an auxiliary API with routines to convert between the differ‐
30     ent RSA public key types used in libfido2 and OpenSSL.
31
32     In libfido2, RS256 public keys are abstracted by the rs256_pk_t type.
33
34     The rs256_pk_new() function returns a pointer to a newly allocated, empty
35     rs256_pk_t type.  If memory cannot be allocated, NULL is returned.
36
37     The rs256_pk_free() function releases the memory backing *pkp, where *pkp
38     must have been previously allocated by rs256_pk_new().  On return, *pkp
39     is set to NULL.  Either pkp or *pkp may be NULL, in which case
40     rs256_pk_free() is a NOP.
41
42     The rs256_pk_from_RSA() function fills pk with the contents of rsa.  No
43     references to rsa are kept.
44
45     The rs256_pk_from_ptr() function fills pk with the contents of ptr, where
46     ptr points to len bytes.  No references to ptr are kept.
47
48     The rs256_pk_to_EVP_PKEY() function converts pk to a newly allocated
49     EVP_PKEY type with a reference count of 1.  No internal references to the
50     returned pointer are kept.  If an error occurs, rs256_pk_to_EVP_PKEY()
51     returns NULL.
52

RETURN VALUES

54     The rs256_pk_from_RSA() and rs256_pk_from_ptr() functions return FIDO_OK
55     on success.  On error, a different error code defined in <fido/err.h> is
56     returned.
57

SEE ALSO

59     eddsa_pk_new(3), es256_pk_new(3), fido_assert_verify(3),
60     fido_cred_pubkey_ptr(3)
61
62BSD                              May 10, 2020                              BSD
Impressum