1LIBRNP(3)                         RNP Manual                         LIBRNP(3)
2
3
4

NAME

6       librnp - OpenPGP implementation, available via FFI interface.
7

SYNOPSIS

9       #include <rnp/rnp.h>
10       #include <rnp/rnp_err.h>
11

DESCRIPTION

13       librnp is part of the RNP suite and forms the basis for the rnp(1) and
14       rnpkeys(1) command-line utilities.
15
16       It provides an FFI interface to functions required for operations
17       needed by the OpenPGP protocol.
18
19       Interface to the library is exposed via <rnp/rnp.h> and <rnp/rnp_err.h>
20       headers. You will also need to link to librnp.
21
22       Please see its headers for the full function list and detailed
23       documentation.
24

EXAMPLES

26       A number of examples are provided in src/examples folder of the RNP
27       suite source tree.
28
29       generate.c
30           Demonstrates generation of an OpenPGP keypair using the JSON key
31           description mechanism. May be used to generate any custom key types
32           that are supported by the RNP suite.
33
34       encrypt.c
35           Demonstrates how to build OpenPGP-encrypted messages. A message is
36           encrypted with keys, generated via ./generate, with a hardcoded
37           password.
38
39       decrypt.c
40           Demonstrates how to decrypt OpenPGP messages. Running this example
41           requires the ./encrypt example to be first run in order to produce
42           the sample encrypted message for decryption.
43
44       sign.c
45           Demonstrates how to sign OpenPGP messages. Running this example
46           requires the ./generate example to be first run in order to
47           generate and write out secret keys.
48
49       verify.c
50           Demonstrates verify OpenPGP signed messages. Again, running this
51           example requires the ./sign example to be first run in order to
52           generate a signed OpenPGP message.
53

BUGS

55       Please report issues via the RNP public issue tracker at:
56       https://github.com/rnpgp/rnp/issues.
57
58       Security reports or security-sensitive feedback should be reported
59       according to the instructions at: https://www.rnpgp.org/feedback.
60

AUTHORS

62       RNP is an open source project led by Ribose and has received
63       contributions from numerous individuals and organizations.
64

RESOURCES

66       Web site: https://www.rnpgp.org
67
68       Source repository: https://github.com/rnpgp/rnp
69

COPYING

71       Copyright (C) 2017-2021 Ribose. The RNP software suite is freely
72       licensed: please refer to the LICENSE file for details.
73

SEE ALSO

75       rnp(1), rnpkeys(1)
76

AUTHOR

78       RNP
79
80
81
82RNP 0.16.2                        2022-11-04                         LIBRNP(3)
Impressum