libssh 0.9.5 The SSH library

misc.h
1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2009 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef MISC_H_
22#define MISC_H_
23
24/* in misc.c */
25/* gets the user home dir. */
26 char *ssh_get_user_home_dir(void);
27 char *ssh_get_local_username(void);
28 int ssh_file_readaccess_ok(const char *file);
29 int ssh_dir_writeable(const char *path);
30
31 char *ssh_path_expand_tilde(const char *d);
32 char *ssh_path_expand_escape(ssh_session session, const char *s);
33 int ssh_analyze_banner(ssh_session session, int server);
34 int ssh_is_ipaddr_v4(const char *str);
35 int ssh_is_ipaddr(const char *str);
36
37/* list processing */
38
39 struct ssh_list {
40 struct ssh_iterator *root;
41 struct ssh_iterator *end;
42};
43
44 struct ssh_iterator {
45 struct ssh_iterator *next;
46 const void *data;
47};
48
49 struct ssh_timestamp {
50 long seconds;
51 long useconds;
52};
53
54 enum ssh_quote_state_e {
55 NO_QUOTE,
56 SINGLE_QUOTE,
57 DOUBLE_QUOTE
58};
59
60 struct ssh_list *ssh_list_new(void);
61 void ssh_list_free(struct ssh_list *list);
62 struct ssh_iterator *ssh_list_get_iterator(const struct ssh_list *list);
63 struct ssh_iterator *ssh_list_find(const struct ssh_list *list, void *value);
64 size_t ssh_list_count(const struct ssh_list *list);
65 int ssh_list_append(struct ssh_list *list, const void *data);
66 int ssh_list_prepend(struct ssh_list *list, const void *data);
67 void ssh_list_remove(struct ssh_list *list, struct ssh_iterator *iterator);
68 char *ssh_lowercase(const char* str);
69 char *ssh_hostport(const char *host, int port);
70
71 const void *_ssh_list_pop_head(struct ssh_list *list);
72
73#define ssh_iterator_value(type, iterator)\
74 ((type)((iterator)->data))
75
81#define ssh_list_pop_head(type, ssh_list)\
82 ((type)_ssh_list_pop_head(ssh_list))
83
84 int ssh_make_milliseconds(long sec, long usec);
85 void ssh_timestamp_init(struct ssh_timestamp *ts);
86 int ssh_timeout_elapsed(struct ssh_timestamp *ts, int timeout);
87 int ssh_timeout_update(struct ssh_timestamp *ts, int timeout);
88
89 int ssh_match_group(const char *group, const char *object);
90
91 void uint64_inc(unsigned char *counter);
92
93 void ssh_log_hexdump(const char *descr, const unsigned char *what, size_t len);
94
95 int ssh_mkdirs(const char *pathname, mode_t mode);
96
97 int ssh_quote_file_name(const char *file_name, char *buf, size_t buf_len);
98 int ssh_newline_vis(const char *string, char *buf, size_t buf_len);
99
100#endif /* MISC_H_ */
ssh_log_hexdump
void ssh_log_hexdump(const char *descr, const unsigned char *what, size_t len)
Log the content of a buffer in hexadecimal format, similar to the output of 'hexdump -C' command.
Definition: misc.c:467
ssh_mkdirs
int ssh_mkdirs(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname. The missing directories in the given pathname...
Definition: misc.c:977
ssh_list_count
size_t ssh_list_count(const struct ssh_list *list)
Get the number of elements in the list.
Definition: misc.c:703
ssh_path_expand_tilde
char * ssh_path_expand_tilde(const char *d)
Expand a directory starting with a tilde '~'.
Definition: misc.c:1037
ssh_timeout_update
int ssh_timeout_update(struct ssh_timestamp *ts, int timeout)
updates a timeout value so it reflects the remaining time
Definition: misc.c:1420
ssh_dir_writeable
int ssh_dir_writeable(const char *path)
Check if the given path is an existing directory and that is accessible for writing.
Definition: misc.c:283
ssh_iterator
Definition: misc.h:44
ssh_list
Definition: misc.h:39
ssh_session_struct
Definition: session.h:109
ssh_timestamp
Definition: misc.h:49