You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by rb...@locus.apache.org on 2000/07/26 07:00:20 UTC
cvs commit: apache-2.0/src/include ap_base64.h
rbb 00/07/25 22:00:20
Modified: src/include ap_base64.h
Log:
Begin to document the Apache 2.0 API in the Apache header files.
Revision Changes Path
1.6 +52 -1 apache-2.0/src/include/ap_base64.h
Index: ap_base64.h
===================================================================
RCS file: /home/cvs/apache-2.0/src/include/ap_base64.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ap_base64.h 2000/05/27 22:53:46 1.5
+++ ap_base64.h 2000/07/26 05:00:20 1.6
@@ -65,6 +65,10 @@
extern "C" {
#endif
+/**
+ * @package Base64 Encoding
+ */
+
/* Simple BASE64 encode/decode functions.
*
* As we might encode binary strings, hence we require the length of
@@ -74,15 +78,62 @@
* or anything non A-Z,0-9 etc as terminal.
*
* plain strings/binary sequences are not assumed '\0' terminated. Encoded
- * strings are neither. But propably should.
+ * strings are neither. But probably should.
*
*/
+
+/**
+ * Given the length of an un-encrypted string, get the length of the encrypted string.
+ * @param the length of an unencrypted string.
+ * @return the length of the string after it is encrypted
+ * @deffunc int ap_base64encode_len(int len)
+ */
API_EXPORT(int) ap_base64encode_len(int len);
+
+/**
+ * Encode a text string using base64encoding.
+ * @param The destination string for the encoded string.
+ * @param The original string in plain text
+ * @param The length of the plain text string
+ * @return the length of the encoded string
+ * @deffunc int ap_base64encode(char *coded_dst, const char *plain_src, int len_plain_src)
+ */
API_EXPORT(int) ap_base64encode(char * coded_dst, const char *plain_src,int len_plain_src);
+
+/**
+ * Encode an EBCDIC string using base64encoding.
+ * @param The destination string for the encoded string.
+ * @param The original string in plain text
+ * @param The length of the plain text string
+ * @return the length of the encoded string
+ * @deffunc int ap_base64encode_binary(char *coded_dst, const char *plain_src, int len_plain_src)
+ */
API_EXPORT(int) ap_base64encode_binary(char * coded_dst, const unsigned char *plain_src,int len_plain_src);
+/**
+ * Determine the length of a plain text string given the encoded version
+ * @param The encoded string
+ * @return the length of the plain text string
+ * @deffunc int ap_base64decode_len(const char *coded_src)
+ */
API_EXPORT(int) ap_base64decode_len(const char * coded_src);
+
+/**
+ * Decode a string to plain text
+ * @param The destination string for the plain text
+ * @param The encoded string
+ * @return the length of the plain text string
+ * @deffunc int ap_base64decode(char *plain_dst, const char *coded_src)
+ */
API_EXPORT(int) ap_base64decode(char * plain_dst, const char *coded_src);
+
+/**
+ * Decode an EBCDIC string to plain text
+ * @param The destination string for the plain text
+ * @param The encoded string
+ * @return the length of the plain text string
+ * @deffunc int ap_base64decode_binary(char *plain_dst, const char *coded_src)
+ */
API_EXPORT(int) ap_base64decode_binary(unsigned char * plain_dst, const char *coded_src);
#ifdef __cplusplus