Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
COAP-RD(5)			 coap-rd Manual 		      COAP-RD(5)

NAME
     coap-rd,  coap-rd-gnutls, coap-rd-mbedtls, coap-rd-openssl, coap-rd-notls -
     CoAP Resource Directory based on libcoap

SYNOPSIS
     coap-rd [-g group] [-p port] [-v num]  [-w  [port][,secure_port]]	[-A  ad-
     dress] [-G group_if] [-T max_token_size] [-V num] [[-h hint] [-k key]] [[-c
     certfile] [-n] [-C cafile] [-R trusted_casfile]]

     For  coap-rd  versions  that  use libcoap compiled for different (D)TLS li-
     braries, coap-rd-notls, coap-rd-gnutls, coap-rd-openssl, coap-rd-mbedtls or
     coap-rd-tinydtls may be available. Otherwise, coap-rd uses the default lib-
     coap (D)TLS support.

DESCRIPTION
     coap-rd is a simple CoAP Resource Directory server that can handle resource
     registrations using the protocol CoAP (RFC 7252).

OPTIONS
     -g group
	 Join specified multicast group on startup.  Note: DTLS  over  multicast
	 is not currently supported.

     -p port
	 The  port  on	the given address will be listening for incoming connec-
	 tions. If (D)TLS is supported, then port + 1 will also be  listened  on
	 for (D)TLS connections. The default port is 5683 if not given any other
	 value.

     -v num
	 The  verbosity  level to use (default 4, maximum is 8) for general CoAP
	 logging.

     -w [port][,secure_port]
	 Enable WebSockets support  support  on  port  (WS)  and/or  secure_port
	 (WSS), comma separated.

     -A address
	 The local address of the interface which the server has to listen on.

     -G group_if
	 Use  this  interface for listening for the multicast group. This can be
	 different from the implied interface if the -A option is used.

     -T max_token_size
	 Set the maximum token length (8-65804).

     -V num
	 The verbosity level to use (default 3, maximum is 7) for (D)TLS library
	 logging.

OPTIONS - PSK
     (If supported by underlying (D)TLS library)

     -h hint
	 Identity Hint to send. Default is CoAP. Zero length is no hint.

     -k key
	 Pre-shared key to use for inbound connections. This cannot be empty  if
	 defined.   Note:  if -c cafile is defined, you need to define -k key as
	 well to have the server support both PSK and PKI.

OPTIONS - PKI
     (If supported by underlying (D)TLS library)

     -c certfile
	 Use the specified PEM file which contains the CERTIFICATE  and  PRIVATE
	 KEY  information.  Note:  if  -k  key is defined, you need to define -c
	 certfile as well to have the server support both PSK and PKI.

     -n
	 Disable remote peer certificate checking. This gives clients the  abil-
	 ity to use PKI, but without any defined certificates.

     -C cafile
	 PEM  file that contains a list of one or more CAs that are to be passed
	 to the client for the client to determine what  client  certificate  to
	 use. Normally, this list of CAs would be the root CA and and any inter-
	 mediate  CAs.	Ideally  the  server certificate should be signed by the
	 same CA so that mutual authentication can take place. The  contents  of
	 cafile  are  added to the trusted store of root CAs. Using the -C or -R
	 options will will trigger the validation of the client certificate  un-
	 less overridden by the -n option.

     -R trust_casfile
	 PEM  file containing the set of trusted root CAs that are to be used to
	 validate the client certificate. Alternatively, this can point to a di-
	 rectory containing a set of CA PEM files. The -C  cafile  CA  does  not
	 have  to  be  in  this list and is trusted for the validation. Using -R
	 trust_casfile disables common CA mutual authentication which  can  only
	 be  done by using -C cafile. Using the -C or -R options will will trig-
	 ger the validation of the server certificate unless overridden  by  the
	 -n option.

EXAMPLES
     *	 Example

	 coap-rd -A ::1

     Let the server listen on localhost (port 5683).

     *	 Example

	 coap-rd -A ::1 -k mysecretKey -h myhint

     Let the server listen on localhost (port 5683 and 5684) with the server set
     up for PSK authentication.

     *	 Example

	 coap-rd -A ::1 -p 13011

     Quite  the  same,	except listening port is 13011 (and not the default port
     5683).

     *	 Example

	 coap-rd -A 2001:db8:81a8:0:6ef0:dead:feed:beef  -v 5

     The listening address is set to 2001:db8:81a8:0:6ef0:dead:feed:beef and the
     verbosity level is set to 5.

     *	 Example

	 coap-rd -A 2001:db8:81a8:0:6ef0:dead:feed:beef  -g FF02::FD

     Set listening address to 2001:db8:81a8:0:6ef0:dead:feed:beef and  join  the
     All CoAP Nodes multicast group FF02::FD.

FILES
     There are no configuration files.

EXIT STATUS
     0
	 Success

     1
	 Failure  (syntax or usage error; configuration error; document process-
	 ing failure; unexpected error)

BUGS
     Please raise an issue on GitHub  at  https://github.com/obgm/libcoap/issues
     to report any bugs.

     Please  raise  a  Pull Request at https://github.com/obgm/libcoap/pulls for
     any fixes.

AUTHORS
     The libcoap project <libcoap-developers@lists.sourceforge.net>

coap-rd 4.3.5			   08/02/2026			      COAP-RD(5)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=coap-rd&sektion=5&manpath=FreeBSD+Ports+15.1.quarterly>

home | help