xref: /third_party/libcoap/doc/main.md (revision c87c5fba)
1libcoap                         {#mainpage}
2=======
3
4A C implementation of the Constrained Application Protocol (RFC 7252)
5=====================================================================
6
7Copyright (C) 2010--2023 by Olaf Bergmann <bergmann@tzi.org> and others
8
9About libcoap
10=============
11
12libcoap is a C implementation of a lightweight application-protocol
13for devices that are constrained their resources such as computing
14power, RF range, memory, bandwidth, or network packet sizes. This
15protocol, CoAP, is standardized by the IETF as RFC 7252. For further
16information related to CoAP, see <https://coap.space> or
17[CoAP Wiki](https://en.wikipedia.org/wiki/Constrained_Application_Protocol).
18
19You might want to check out
20[libcoap-minimal](https://github.com/obgm/libcoap-minimal) for usage
21examples.
22
23The following RFCs are supported
24
25* [RFC7252: The Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7252)
26
27* [RFC7390: Group Communication for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7390)
28
29* [RFC7641: Observing Resources in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7641)
30
31* [RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7959)
32
33* [RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response](https://rfc-editor.org/rfc/rfc7967)
34
35* [RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8132)
36
37* [RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets](https://rfc-editor.org/rfc/rfc8323)
38
39* [RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol](https://rfc-editor.org/rfc/rfc8516)
40
41* [RFC8613: Object Security for Constrained RESTful Environments (OSCORE)](https://rfc-editor.org/rfc/rfc8613)
42
43* [RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option](https://rfc-editor.org/rfc/rfc8768)
44
45* [RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8974)
46
47* [RFC9175: CoAP: Echo, Request-Tag, and Token Processing](https://rfc-editor.org/rfc/rfc9175)
48
49* [RFC9177: Constrained Application Protocol (CoAP) Block-Wise Transfer Options Supporting Robust Transmission](https://rfc-editor.org/rfc/rfc9177)
50
51There is (D)TLS support for the following libraries
52
53* [OpenSSL](https://www.openssl.org) (Minimum version 1.1.0) [PKI, PSK and PKCS11]
54
55* [GnuTLS](https://www.gnutls.org) (Minimum version 3.3.0) [PKI, PSK, RPK(3.6.6+) and PKCS11]
56
57* [Mbed TLS](https://www.trustedfirmware.org/projects/mbed-tls/) (Minimum version 2.7.10) [PKI and PSK]
58
59* [TinyDTLS](https://github.com/eclipse/tinydtls) [PSK and RPK] [DTLS Only]
60
61Documentation
62=============
63
64This set of pages contains the current set of documention for the libcoap APIs.
65
66License Information
67===================
68
69This library is published as open-source software without any warranty
70of any kind. Use is permitted under the terms of the simplified BSD
71license. It includes public domain software. libcoap binaries may also
72include open-source software with their respective licensing terms.
73Please refer to
74[LICENSE](https://raw.githubusercontent.com/obgm/libcoap/develop/LICENSE)
75for further details in the source.
76