home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277194_apr_base64.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  4KB  |  111 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  * The apr_vsnprintf/apr_snprintf functions are based on, and used with the
  15.  * permission of, the  SIO stdio-replacement strx_* functions by Panos
  16.  * Tsirigotis <panos@alumni.cs.colorado.edu> for xinetd.
  17.  */
  18.  
  19. /**
  20.  * @file apr_base64.h
  21.  * @brief APR-UTIL Base64 Encoding
  22.  */
  23. #ifndef APR_BASE64_H
  24. #define APR_BASE64_H
  25.  
  26. #include "apu.h"
  27. #include "apr_general.h"
  28.  
  29. #ifdef __cplusplus
  30. extern "C" {
  31. #endif
  32.  
  33. /**
  34.  * @defgroup APR_Util_Base64 Base64 Encoding
  35.  * @ingroup APR_Util
  36.  * @{
  37.  */
  38.  
  39. /* Simple BASE64 encode/decode functions.
  40.  * 
  41.  * As we might encode binary strings, hence we require the length of
  42.  * the incoming plain source. And return the length of what we decoded.
  43.  *
  44.  * The decoding function takes any non valid char (i.e. whitespace, \0
  45.  * or anything non A-Z,0-9 etc as terminal.
  46.  * 
  47.  * plain strings/binary sequences are not assumed '\0' terminated. Encoded
  48.  * strings are neither. But probably should.
  49.  *
  50.  */
  51.  
  52. /**
  53.  * Given the length of an un-encrypted string, get the length of the 
  54.  * encrypted string.
  55.  * @param len the length of an unencrypted string.
  56.  * @return the length of the string after it is encrypted
  57.  */ 
  58. APU_DECLARE(int) apr_base64_encode_len(int len);
  59.  
  60. /**
  61.  * Encode a text string using base64encoding.
  62.  * @param coded_dst The destination string for the encoded string.
  63.  * @param plain_src The original string in plain text
  64.  * @param len_plain_src The length of the plain text string
  65.  * @return the length of the encoded string
  66.  */ 
  67. APU_DECLARE(int) apr_base64_encode(char * coded_dst, const char *plain_src, 
  68.                                  int len_plain_src);
  69.  
  70. /**
  71.  * Encode an EBCDIC string using base64encoding.
  72.  * @param coded_dst The destination string for the encoded string.
  73.  * @param plain_src The original string in plain text
  74.  * @param len_plain_src The length of the plain text string
  75.  * @return the length of the encoded string
  76.  */ 
  77. APU_DECLARE(int) apr_base64_encode_binary(char * coded_dst, 
  78.                                         const unsigned char *plain_src,
  79.                                         int len_plain_src);
  80.  
  81. /**
  82.  * Determine the length of a plain text string given the encoded version
  83.  * @param coded_src The encoded string
  84.  * @return the length of the plain text string
  85.  */ 
  86. APU_DECLARE(int) apr_base64_decode_len(const char * coded_src);
  87.  
  88. /**
  89.  * Decode a string to plain text
  90.  * @param plain_dst The destination string for the plain text
  91.  * @param coded_src The encoded string 
  92.  * @return the length of the plain text string
  93.  */ 
  94. APU_DECLARE(int) apr_base64_decode(char * plain_dst, const char *coded_src);
  95.  
  96. /**
  97.  * Decode an EBCDIC string to plain text
  98.  * @param plain_dst The destination string for the plain text
  99.  * @param coded_src The encoded string 
  100.  * @return the length of the plain text string
  101.  */ 
  102. APU_DECLARE(int) apr_base64_decode_binary(unsigned char * plain_dst, 
  103.                                         const char *coded_src);
  104.  
  105. /** @} */
  106. #ifdef __cplusplus
  107. }
  108. #endif
  109.  
  110. #endif    /* !APR_BASE64_H */
  111.