1= librnp(3)
2RNP
3:doctype: manpage
4:release-version: {component-version}
5:man manual: RNP Manual
6:man source: RNP {release-version}
7
8== NAME
9
10librnp - OpenPGP implementation, available via FFI interface.
11
12== SYNOPSIS
13
14*#include <rnp/rnp.h>* +
15*#include <rnp/rnp_err.h>*
16
17
18== DESCRIPTION
19
20*librnp* is part of the *RNP* suite and forms the basis for the _rnp(1)_ and _rnpkeys(1)_ command-line utilities.
21
22It provides an FFI interface to functions required for operations needed by the OpenPGP protocol.
23
24Interface to the library is exposed via _<rnp/rnp.h>_ and _<rnp/rnp_err.h>_ headers.
25You will also need to link to _librnp_.
26
27Please see its headers for the full function list and detailed documentation.
28
29== EXAMPLES
30
31A number of examples are provided in *src/examples* folder of the *RNP* suite source tree.
32
33*generate.c*::
34Demonstrates generation of an OpenPGP keypair using the JSON key description mechanism.
35May be used to generate any custom key types that are supported by the *RNP* suite.
36
37*encrypt.c*::
38Demonstrates how to build OpenPGP-encrypted messages.
39A message is encrypted with keys, generated via *./generate*, with a hardcoded password.
40
41*decrypt.c*::
42Demonstrates how to decrypt OpenPGP messages.
43Running this example requires the *./encrypt* example to be first run
44in order to produce the sample encrypted message for decryption.
45
46*sign.c*::
47Demonstrates how to sign OpenPGP messages.
48Running this example requires the *./generate* example to be first run
49in order to generate and write out secret keys.
50
51*verify.c*::
52Demonstrates verify OpenPGP signed messages.
53Again, running this example requires the *./sign* example to be first run
54in order to generate a signed OpenPGP message.
55
56== BUGS
57
58Please report _issues_ via the RNP public issue tracker at:
59https://github.com/rnpgp/rnp/issues.
60
61_Security reports_ or _security-sensitive feedback_ should be reported
62according to the instructions at:
63https://www.rnpgp.org/feedback.
64
65
66== AUTHORS
67
68*RNP* is an open source project led by Ribose and has
69received contributions from numerous individuals and
70organizations.
71
72
73== RESOURCES
74
75*Web site*: https://www.rnpgp.org
76
77*Source repository*: https://github.com/rnpgp/rnp
78
79
80== COPYING
81
82Copyright \(C) 2017-2021 Ribose.
83The RNP software suite is _freely licensed_:
84please refer to the *LICENSE* file for details.
85
86
87== SEE ALSO
88
89*rnp(1)*, *rnpkeys(1)*
90