src/core/lib/slice/b64.h

   1 /*
   2  *
   3  * Copyright 2015 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_CORE_LIB_SLICE_B64_H
  20 #define GRPC_CORE_LIB_SLICE_B64_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <grpc/slice.h>
  25
  26 /* Encodes data using base64. It is the caller's responsibility to free
  27    the returned char * using gpr_free. Returns NULL on NULL input.
  28    TODO(makdharma) : change the flags to bool from int */
  29 char* grpc_base64_encode(const void* data, size_t data_size, int url_safe,
  30                          int multiline);
  31
  32 /* estimate the upper bound on size of base64 encoded data. The actual size
  33  * is guaranteed to be less than or equal to the size returned here. */
  34 size_t grpc_base64_estimate_encoded_size(size_t data_size, int url_safe,
  35                                          int multiline);
  36
  37 /* Encodes data using base64 and write it to memory pointed to by result. It is
  38  * the caller's responsibility to allocate enough memory in |result| to fit the
  39  * encoded data. */
  40 void grpc_base64_encode_core(char* result, const void* vdata, size_t data_size,
  41                              int url_safe, int multiline);
  42
  43 /* Decodes data according to the base64 specification. Returns an empty
  44    slice in case of failure. */
  45 grpc_slice grpc_base64_decode(const char* b64, int url_safe);
  46
  47 /* Same as above except that the length is provided by the caller. */
  48 grpc_slice grpc_base64_decode_with_len(const char* b64, size_t b64_len,
  49                                        int url_safe);
  50
  51 #endif /* GRPC_CORE_LIB_SLICE_B64_H */