minix/external/bsd/bind/dist/lib/isccc/include/isccc/base64.h
David van Moolenbroek 00b67f09dd Import NetBSD named(8)
Also known as ISC bind.  This import adds utilities such as host(1),
dig(1), and nslookup(1), as well as many other tools and libraries.

Change-Id: I035ca46e64f1965d57019e773f4ff0ef035e4aa3
2017-03-21 22:00:06 +00:00

88 lines
3.0 KiB
C

/* $NetBSD: base64.h,v 1.4 2014/12/10 04:38:01 christos Exp $ */
/*
* Portions Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
* Portions Copyright (C) 2001 Internet Software Consortium.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NOMINUM DISCLAIMS ALL
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* Portions Copyright (C) 2001 Nominum, Inc.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NOMINUM DISCLAIMS ALL
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/* Id: base64.h,v 1.10 2007/08/28 07:20:43 tbox Exp */
#ifndef ISCCC_BASE64_H
#define ISCCC_BASE64_H 1
/*! \file isccc/base64.h */
#include <isc/lang.h>
#include <isccc/types.h>
ISC_LANG_BEGINDECLS
/***
*** Functions
***/
isc_result_t
isccc_base64_encode(isccc_region_t *source, int wordlength,
const char *wordbreak, isccc_region_t *target);
/*%<
* Convert data into base64 encoded text.
*
* Notes:
*\li The base64 encoded text in 'target' will be divided into
* words of at most 'wordlength' characters, separated by
* the 'wordbreak' string. No parentheses will surround
* the text.
*
* Requires:
*\li 'source' is a region containing binary data.
*\li 'target' is a text region containing available space.
*\li 'wordbreak' points to a null-terminated string of
* zero or more whitespace characters.
*/
isc_result_t
isccc_base64_decode(const char *cstr, isccc_region_t *target);
/*%<
* Decode a null-terminated base64 string.
*
* Requires:
*\li 'cstr' is non-null.
*\li 'target' is a valid region.
*
* Returns:
*\li #ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
* fit in 'target'.
*\li #ISC_R_BADBASE64 -- 'cstr' is not a valid base64 encoding.
*\li #ISC_R_NOSPACE -- 'target' is not big enough.
*/
ISC_LANG_ENDDECLS
#endif /* ISCCC_BASE64_H */