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

FreeBSD Manual Pages

  
 
  

home | help
jose_b64(3)		   Library Functions Manual		   jose_b64(3)

NAME
       jose_b64	- URL-safe Base64 Encoding & Decoding.

SYNOPSIS
   Functions
       size_t jose_b64_dec (const json_t *i, void *o, size_t ol)
	   Decodes a URL-safe Base64 JSON string to a buffer.
       jose_io_t * jose_b64_dec_io (jose_io_t *next)
	   Creates a new IO object which performs URL-safe Base64 decoding.
       size_t jose_b64_dec_buf (const void *i, size_t il, void *o, size_t ol)
	   Decodes a URL-safe Base64 buffer to an output buffer.
       json_t *	jose_b64_dec_load (const json_t	*i)
	   Decodes a JSON string from a	URL-safe Base64	JSON string.
       json_t *	jose_b64_enc (const void *i, size_t il)
	   Encodes data	to a URL-safe Base64 JSON string.
       jose_io_t * jose_b64_enc_io (jose_io_t *next)
	   Creates a new IO object which performs URL-safe Base64 encoding.
       size_t jose_b64_enc_buf (const void *i, size_t il, void *o, size_t ol)
	   Encodes data	to a URL-safe Base64 buffer.
       json_t *	jose_b64_enc_dump (const json_t	*i)
	   Encodes the input JSON as a URL-safe	Base64 JSON string.

Detailed Description
       URL-safe	Base64 Encoding	& Decoding.

Function Documentation
   size_t jose_b64_dec (const json_t * i, void * o, size_t ol)
       Decodes a URL-safe Base64 JSON string to	a buffer. If o is NULL,	the
       number of output	bytes necessary	is returned.

       This function will never	write more than	ol bytes. If the output	buffer
       is too small, an	error will occur.

       Parameters:
	   i The input URL-safe	Base64 JSON string.
	   o The output	buffer (may be NULL).
	   ol The size of the output buffer.

       Returns:
	   The number of bytes that were (or would be) written.	If an error
	   occurs, SIZE_MAX is returned.

   jose_io_t* jose_b64_dec_io (jose_io_t * next)
       Creates a new IO	object which performs URL-safe Base64 decoding.	All
       data written to the returned IO object will be decoded before passing
       it on to	the next IO object in the chain.

       Parameters:
	   next	The next IO object in the chain.

       Returns:
	   The new IO object or	NULL on	error.

   size_t jose_b64_dec_buf (const void * i, size_t il, void * o, size_t	ol)
       Decodes a URL-safe Base64 buffer	to an output buffer. If	o is NULL, the
       number of output	bytes necessary	is returned.

       This function will never	write more than	ol bytes. If the output	buffer
       is too small, an	error will occur.

       Parameters:
	   i The input URL-safe	Base64 buffer.
	   il The size of the data in the input	buffer.
	   o The output	buffer.
	   ol The size of the output buffer.

       Returns:
	   The number of bytes that were (or would be) written.	If an error
	   occurs, SIZE_MAX is returned.

   json_t* jose_b64_dec_load (const json_t * i)
       Decodes a JSON string from a URL-safe Base64 JSON string.

       Parameters:
	   i The input URL-safe	Base64 JSON string containing JSON data.

       Returns:
	   The output JSON data.

   json_t* jose_b64_enc	(const void * i, size_t	il)
       Encodes data to a URL-safe Base64 JSON string.

       Parameters:
	   i The input buffer.
	   il The size of the data in the input	buffer.

       Returns:
	   The decoded JSON data. If an	error occurs, NULL is returned.

   jose_io_t* jose_b64_enc_io (jose_io_t * next)
       Creates a new IO	object which performs URL-safe Base64 encoding.	All
       data written to the returned IO object will be encoded before passing
       it on to	the next IO object in the chain.

       Parameters:
	   next	The next IO object in the chain.

       Returns:
	   The new IO object or	NULL on	error.

   size_t jose_b64_enc_buf (const void * i, size_t il, void * o, size_t	ol)
       Encodes data to a URL-safe Base64 buffer. If o is NULL, the number of
       output bytes necessary is returned.

       This function will never	write more than	ol bytes. If the output	buffer
       is too small, an	error will occur.

       Parameters:
	   i The input buffer.
	   il The size of the data in the input	buffer.
	   o The output	URL-safe Base64	buffer.
	   ol The size of the output buffer.

       Returns:
	   The number of bytes that were (or would be) written.	If an error
	   occurs, SIZE_MAX is returned.

   json_t* jose_b64_enc_dump (const json_t * i)
       Encodes the input JSON as a URL-safe Base64 JSON	string.

       Parameters:
	   i The input JSON data.

       Returns:
	   The output URL-safe Base64 JSON string.

Author
       Generated automatically by Doxygen for Jos from the source code.

Jos				Tue May	30 2017			   jose_b64(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=jose_b64&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help