Wed Jan 8 2020 09:50:12

Asterisk developer's documentation


func_base64.c File Reference

Use the base64 as functions. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/strings.h"

Go to the source code of this file.

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static int base64_buf_helper (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 
static int base64_helper (struct ast_channel *chan, const char *cmd, char *data, char *buf, struct ast_str **str, ssize_t len)
 
static int base64_str_helper (struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
 
static int load_module (void)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "base64 encode/decode dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
 
static struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_custom_function base64_decode_function
 
static struct ast_custom_function base64_encode_function
 

Detailed Description

Use the base64 as functions.

Definition in file func_base64.c.

Function Documentation

static void __reg_module ( void  )
static

Definition at line 159 of file func_base64.c.

static void __unreg_module ( void  )
static

Definition at line 159 of file func_base64.c.

static int base64_buf_helper ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
)
static

Definition at line 123 of file func_base64.c.

References base64_helper().

125 {
126  return base64_helper(chan, cmd, data, buf, NULL, len);
127 }
static int base64_helper(struct ast_channel *chan, const char *cmd, char *data, char *buf, struct ast_str **str, ssize_t len)
Definition: func_base64.c:77
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
static int base64_helper ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
struct ast_str **  str,
ssize_t  len 
)
static

Definition at line 77 of file func_base64.c.

References ast_base64decode(), ast_base64encode(), ast_log(), ast_str_buffer(), ast_str_make_space(), ast_str_size(), ast_str_strlen(), ast_str_update(), ast_strlen_zero(), and LOG_WARNING.

Referenced by base64_buf_helper(), and base64_str_helper().

79 {
80  if (ast_strlen_zero(data)) {
81  ast_log(LOG_WARNING, "Syntax: %s(<data>) - missing argument!\n", cmd);
82  return -1;
83  }
84 
85  if (cmd[7] == 'E') {
86  if (buf) {
87  ast_base64encode(buf, (unsigned char *) data, strlen(data), len);
88  } else {
89  if (len >= 0) {
90  ast_str_make_space(str, len ? len : ast_str_strlen(*str) + strlen(data) * 4 / 3 + 2);
91  }
92  ast_base64encode(ast_str_buffer(*str) + ast_str_strlen(*str), (unsigned char *) data, strlen(data), ast_str_size(*str) - ast_str_strlen(*str));
93  ast_str_update(*str);
94  }
95  } else {
96  int decoded_len;
97  if (buf) {
98  decoded_len = ast_base64decode((unsigned char *) buf, data, len);
99  /* add a terminating null at the end of buf, or at the
100  * end of our decoded string, which ever is less */
101  buf[decoded_len <= (len - 1) ? decoded_len : len - 1] = '\0';
102  } else {
103  if (len >= 0) {
104  ast_str_make_space(str, len ? len : ast_str_strlen(*str) + strlen(data) * 3 / 4 + 2);
105  }
106  decoded_len = ast_base64decode((unsigned char *) ast_str_buffer(*str) + ast_str_strlen(*str), data, ast_str_size(*str) - ast_str_strlen(*str));
107  if (len)
108  /* add a terminating null at the end of our
109  * buffer, or at the end of our decoded string,
110  * which ever is less */
111  ast_str_buffer(*str)[decoded_len <= (len - 1) ? decoded_len : len - 1] = '\0';
112  else
113  /* space for the null is allocated above */
114  ast_str_buffer(*str)[decoded_len] = '\0';
115 
116  ast_str_update(*str);
117  }
118  }
119 
120  return 0;
121 }
size_t ast_str_size(const struct ast_str *buf)
Returns the current maximum length (without reallocation) of the current buffer.
Definition: strings.h:482
#define LOG_WARNING
Definition: logger.h:144
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:497
int ast_base64decode(unsigned char *dst, const char *src, int max)
Decode data from base64.
Definition: utils.c:279
int ast_str_make_space(struct ast_str **buf, size_t new_len)
Definition: strings.h:588
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max)
Encode data in base64.
Definition: utils.c:357
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
size_t ast_str_strlen(const struct ast_str *buf)
Returns the current length of the string stored within buf.
Definition: strings.h:471
void ast_str_update(struct ast_str *buf)
Update the length of the buffer, after using ast_str merely as a buffer.
Definition: strings.h:446
static int base64_str_helper ( struct ast_channel chan,
const char *  cmd,
char *  data,
struct ast_str **  buf,
ssize_t  len 
)
static

Definition at line 129 of file func_base64.c.

References base64_helper().

131 {
132  return base64_helper(chan, cmd, data, NULL, buf, len);
133 }
static int base64_helper(struct ast_channel *chan, const char *cmd, char *data, char *buf, struct ast_str **str, ssize_t len)
Definition: func_base64.c:77
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
static int load_module ( void  )
static

Definition at line 153 of file func_base64.c.

References ast_custom_function_register.

154 {
157 }
static struct ast_custom_function base64_decode_function
Definition: func_base64.c:141
static struct ast_custom_function base64_encode_function
Definition: func_base64.c:135
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1164
static int unload_module ( void  )
static

Definition at line 147 of file func_base64.c.

References ast_custom_function_unregister().

148 {
151 }
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx.c:3814
static struct ast_custom_function base64_decode_function
Definition: func_base64.c:141
static struct ast_custom_function base64_encode_function
Definition: func_base64.c:135

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "base64 encode/decode dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static

Definition at line 159 of file func_base64.c.

Definition at line 159 of file func_base64.c.

struct ast_custom_function base64_decode_function
static
Initial value:
= {
.name = "BASE64_DECODE",
}
static int base64_buf_helper(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_base64.c:123
static int base64_str_helper(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_base64.c:129

Definition at line 141 of file func_base64.c.

struct ast_custom_function base64_encode_function
static
Initial value:
= {
.name = "BASE64_ENCODE",
}
static int base64_buf_helper(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_base64.c:123
static int base64_str_helper(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_base64.c:129

Definition at line 135 of file func_base64.c.