2 * Prototypes for lib directory of Bacula
7 Copyright (C) 2000-2005 Kern Sibbald
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License as
11 published by the Free Software Foundation; either version 2 of
12 the License, or (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU General Public
20 License along with this program; if not, write to the Free
21 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 void free_attr(ATTR *attr);
31 int unpack_attributes_record(JCR *jcr, int32_t stream, char *rec, ATTR *attr);
32 void build_attr_output_fnames(JCR *jcr, ATTR *attr);
33 void print_ls_output(JCR *jcr, ATTR *attr);
36 void base64_init (void);
37 int to_base64 (intmax_t value, char *where);
38 int from_base64 (intmax_t *value, char *where);
39 int bin_to_base64 (char *buf, char *bin, int len);
42 char *bstrncpy (char *dest, const char *src, int maxlen);
43 char *bstrncpy (char *dest, POOL_MEM &src, int maxlen);
44 char *bstrncat (char *dest, const char *src, int maxlen);
45 char *bstrncat (char *dest, POOL_MEM &src, int maxlen);
46 int cstrlen (const char *str);
47 void *b_malloc (const char *file, int line, size_t size);
49 void *bmalloc (size_t size);
51 void *brealloc (void *buf, size_t size);
52 void *bcalloc (size_t size1, size_t size2);
53 int bsnprintf (char *str, int32_t size, const char *format, ...);
54 int bvsnprintf (char *str, int32_t size, const char *format, va_list ap);
55 int pool_sprintf (char *pool_buf, const char *fmt, ...);
56 void create_pid_file (char *dir, const char *progname, int port);
57 int delete_pid_file (char *dir, const char *progname, int port);
58 void drop (char *uid, char *gid);
59 int bmicrosleep (time_t sec, long usec);
60 char *bfgets (char *s, int size, FILE *fd);
61 void make_unique_filename (POOLMEM **name, int Id, char *what);
63 long long int strtoll (const char *ptr, char **endptr, int base);
65 void read_state_file(char *dir, const char *progname, int port);
66 int bstrerror(int errnum, char *buf, size_t bufsiz);
69 int32_t bnet_recv (BSOCK *bsock);
70 bool bnet_send (BSOCK *bsock);
71 bool bnet_fsend (BSOCK *bs, const char *fmt, ...);
72 bool bnet_set_buffer_size (BSOCK *bs, uint32_t size, int rw);
73 bool bnet_sig (BSOCK *bs, int sig);
74 int bnet_tls_server (TLS_CONTEXT *ctx, BSOCK *bsock,
76 int bnet_tls_client (TLS_CONTEXT *ctx, BSOCK *bsock);
77 BSOCK * bnet_connect (JCR *jcr, int retry_interval,
78 int max_retry_time, const char *name, char *host, char *service,
79 int port, int verbose);
80 void bnet_close (BSOCK *bsock);
81 BSOCK * init_bsock (JCR *jcr, int sockfd, const char *who, const char *ip,
82 int port, struct sockaddr *client_addr);
83 BSOCK * dup_bsock (BSOCK *bsock);
84 void term_bsock (BSOCK *bsock);
85 const char *bnet_strerror (BSOCK *bsock);
86 const char *bnet_sig_to_ascii (BSOCK *bsock);
87 int bnet_wait_data (BSOCK *bsock, int sec);
88 int bnet_wait_data_intr (BSOCK *bsock, int sec);
89 int bnet_despool_to_bsock (BSOCK *bsock, void update(ssize_t size), ssize_t size);
90 bool is_bnet_stop (BSOCK *bsock);
91 int is_bnet_error (BSOCK *bsock);
92 void bnet_suppress_error_messages(BSOCK *bsock, bool flag);
93 dlist *bnet_host2ipaddrs(const char *host, int family, const char **errstr);
94 int bnet_set_blocking (BSOCK *sock);
95 int bnet_set_nonblocking (BSOCK *sock);
96 void bnet_restore_blocking (BSOCK *sock, int flags);
99 int bget_msg(BSOCK *sock);
102 BPIPE * open_bpipe(char *prog, int wait, const char *mode);
103 int close_wpipe(BPIPE *bpipe);
104 int close_bpipe(BPIPE *bpipe);
107 int cram_md5_get_auth(BSOCK *bs, char *password, int *tls_remote_need);
108 int cram_md5_auth(BSOCK *bs, char *password, int tls_local_need);
109 void hmac_md5(uint8_t* text, int text_len, uint8_t* key,
110 int key_len, uint8_t *hmac);
114 uint32_t bcrc32(uint8_t *buf, int len);
117 int init_crypto (void);
118 int cleanup_crypto (void);
119 DIGEST * crypto_digest_new (crypto_digest_t type);
120 bool crypto_digest_update (DIGEST *digest, const void *data, size_t length);
121 bool crypto_digest_finalize (DIGEST *digest, void *dest, size_t *length);
122 void crypto_digest_free (DIGEST *digest);
123 SIGNATURE * crypto_sign_new (void);
124 crypto_error_t crypto_sign_get_digest (SIGNATURE *sig, X509_KEYPAIR *keypair, DIGEST **digest);
125 crypto_error_t crypto_sign_verify (SIGNATURE *sig, X509_KEYPAIR *keypair, DIGEST *digest);
126 int crypto_sign_add_signer (SIGNATURE *sig, DIGEST *digest, X509_KEYPAIR *keypair);
127 int crypto_sign_encode (SIGNATURE *sig, void *dest, size_t *length);
128 SIGNATURE * crypto_sign_decode (const void *sigData, size_t length);
129 void crypto_sign_free (SIGNATURE *sig);
130 CRYPTO_SESSION * crypto_session_new (crypto_cipher_t cipher, alist *pubkeys);
131 void crypto_session_free (CRYPTO_SESSION *cs);
132 bool crypto_session_encode (CRYPTO_SESSION *cs, void *dest, size_t *length);
133 crypto_error_t crypto_session_decode (const void *data, size_t length, alist *keypairs, CRYPTO_SESSION **session);
134 CRYPTO_SESSION * crypto_session_decode (const void *data, size_t length);
135 X509_KEYPAIR * crypto_keypair_new (void);
136 X509_KEYPAIR * crypto_keypair_dup (X509_KEYPAIR *keypair);
137 int crypto_keypair_load_cert (X509_KEYPAIR *keypair, const char *file);
138 bool crypto_keypair_has_key (const char *file);
139 int crypto_keypair_load_key (X509_KEYPAIR *keypair, const char *file, CRYPTO_PEM_PASSWD_CB *pem_callback, const void *pem_userdata);
140 void crypto_keypair_free (X509_KEYPAIR *keypair);
141 int crypto_default_pem_callback (char *buf, int size, const void *userdata);
142 const char * crypto_digest_name (DIGEST *digest);
143 crypto_digest_t crypto_digest_stream_type (int stream);
144 const char * crypto_strerror (crypto_error_t error);
147 void daemon_start ();
150 uint64_t str_to_uint64(char *str);
151 int64_t str_to_int64(char *str);
152 #define str_to_int32(str) ((int32_t)str_to_int64(str))
153 char * edit_uint64_with_commas (uint64_t val, char *buf);
154 char * add_commas (char *val, char *buf);
155 char * edit_uint64 (uint64_t val, char *buf);
156 char * edit_int64 (int64_t val, char *buf);
157 bool duration_to_utime (char *str, utime_t *value);
158 bool size_to_uint64(char *str, int str_len, uint64_t *rtn_value);
159 char *edit_utime (utime_t val, char *buf, int buf_len);
160 bool is_a_number (const char *num);
161 bool is_an_integer (const char *n);
162 bool is_name_valid (char *name, POOLMEM **msg);
164 /* jcr.c (most definitions are in src/jcr.h) */
165 void init_last_jobs_list();
166 void term_last_jobs_list();
167 void lock_last_jobs_list();
168 void unlock_last_jobs_list();
169 bool read_last_jobs_list(int fd, uint64_t addr);
170 uint64_t write_last_jobs_list(int fd, uint64_t addr);
171 void write_state_file(char *dir, const char *progname, int port);
172 void job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx);
175 JCR *jcr_walk_start();
176 JCR *jcr_walk_next(JCR *prev_jcr);
177 void jcr_walk_end(JCR *jcr);
181 LEX * lex_close_file (LEX *lf);
182 LEX * lex_open_file (LEX *lf, const char *fname, LEX_ERROR_HANDLER *scan_error);
183 int lex_get_char (LEX *lf);
184 void lex_unget_char (LEX *lf);
185 const char * lex_tok_to_str (int token);
186 int lex_get_token (LEX *lf, int expect);
187 void lex_set_default_error_handler (LEX *lf);
190 void my_name_is (int argc, char *argv[], const char *name);
191 void init_msg (JCR *jcr, MSGS *msg);
192 void term_msg (void);
193 void close_msg (JCR *jcr);
194 void add_msg_dest (MSGS *msg, int dest, int type, char *where, char *dest_code);
195 void rem_msg_dest (MSGS *msg, int dest, int type, char *where);
196 void Jmsg (JCR *jcr, int type, time_t mtime, const char *fmt, ...);
197 void dispatch_message (JCR *jcr, int type, time_t mtime, char *buf);
198 void init_console_msg (const char *wd);
199 void free_msgs_res (MSGS *msgs);
200 void dequeue_messages (JCR *jcr);
201 void set_trace (int trace_flag);
204 void bnet_thread_server(dlist *addr, int max_clients, workq_t *client_wq,
205 void *handle_client_request(void *bsock));
206 void bnet_stop_thread_server(pthread_t tid);
207 void bnet_server (int port, void handle_client_request(BSOCK *bsock));
208 int net_connect (int port);
209 BSOCK * bnet_bind (int port);
210 BSOCK * bnet_accept (BSOCK *bsock, char *who);
213 char *getuser(uid_t uid);
214 void free_getuser_cache();
215 char *getgroup (gid_t gid);
216 void free_getgroup_cache();
219 typedef int (EVENT_HANDLER)(JCR *jcr, const char *event);
220 void init_python_interpreter(const char *progname, const char *scripts,
222 void term_python_interpreter();
223 //extern EVENT_HANDLER *generate_daemon_event;
224 int generate_daemon_event(JCR *jcr, const char *event);
227 void init_signals (void terminate(int sig));
228 void init_stack_dump (void);
231 void strip_leading_space (char *str);
232 void strip_trailing_junk (char *str);
233 void strip_trailing_slashes (char *dir);
234 bool skip_spaces (char **msg);
235 bool skip_nonspaces (char **msg);
236 int fstrsch (const char *a, const char *b);
237 char *next_arg(char **s);
238 int parse_args(POOLMEM *cmd, POOLMEM **args, int *argc,
239 char **argk, char **argv, int max_args);
240 void split_path_and_filename(const char *fname, POOLMEM **path,
241 int *pnl, POOLMEM **file, int *fnl);
242 int bsscanf(const char *buf, const char *fmt, ...);
246 TLS_CONTEXT *new_tls_context (const char *ca_certfile,
247 const char *ca_certdir,
248 const char *certfile,
250 CRYPTO_PEM_PASSWD_CB *pem_callback,
251 const void *pem_userdata,
254 void free_tls_context (TLS_CONTEXT *ctx);
256 bool tls_postconnect_verify_host (TLS_CONNECTION *tls,
258 bool tls_postconnect_verify_cn (TLS_CONNECTION *tls,
260 TLS_CONNECTION *new_tls_connection (TLS_CONTEXT *ctx, int fd);
261 void free_tls_connection (TLS_CONNECTION *tls);
262 bool tls_bsock_connect (BSOCK *bsock);
263 bool tls_bsock_accept (BSOCK *bsock);
264 void tls_bsock_shutdown (BSOCK *bsock);
265 int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes);
266 int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes);
267 #endif /* HAVE_TLS */
271 int is_buf_zero (char *buf, int len);
272 void lcase (char *str);
273 void bash_spaces (char *str);
274 void bash_spaces (POOL_MEM &pm);
275 void unbash_spaces (char *str);
276 void unbash_spaces (POOL_MEM &pm);
277 char * encode_time (time_t time, char *buf);
278 char * encode_mode (mode_t mode, char *buf);
279 int do_shell_expansion (char *name, int name_len);
280 void jobstatus_to_ascii (int JobStatus, char *msg, int maxlen);
281 int run_program (char *prog, int wait, POOLMEM *results);
282 int run_program_full_output (char *prog, int wait, POOLMEM *results);
283 const char * job_type_to_str (int type);
284 const char * job_status_to_str (int stat);
285 const char * job_level_to_str (int level);
286 void make_session_key (char *key, char *seed, int mode);
287 POOLMEM *edit_job_codes(JCR *jcr, char *omsg, char *imsg, const char *to);
288 void set_working_directory(char *wd);
292 int start_watchdog(void);
293 int stop_watchdog(void);
294 watchdog_t *new_watchdog(void);
295 bool register_watchdog(watchdog_t *wd);
296 bool unregister_watchdog(watchdog_t *wd);
299 btimer_t *start_child_timer(pid_t pid, uint32_t wait);
300 void stop_child_timer(btimer_t *wid);
301 btimer_t *start_thread_timer(pthread_t tid, uint32_t wait);
302 void stop_thread_timer(btimer_t *wid);
303 btimer_t *start_bsock_timer(BSOCK *bs, uint32_t wait);
304 void stop_bsock_timer(btimer_t *wid);