libssh  0.10.6
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 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* in misc.c */
29 /* gets the user home dir. */
30 char *ssh_get_user_home_dir(void);
31 char *ssh_get_local_username(void);
32 int ssh_file_readaccess_ok(const char *file);
33 int ssh_dir_writeable(const char *path);
34 
35 char *ssh_path_expand_tilde(const char *d);
36 char *ssh_path_expand_escape(ssh_session session, const char *s);
37 int ssh_analyze_banner(ssh_session session, int server);
38 int ssh_is_ipaddr_v4(const char *str);
39 int ssh_is_ipaddr(const char *str);
40 
41 /* list processing */
42 
43 struct ssh_list {
44  struct ssh_iterator *root;
45  struct ssh_iterator *end;
46 };
47 
48 struct ssh_iterator {
49  struct ssh_iterator *next;
50  const void *data;
51 };
52 
53 struct ssh_timestamp {
54  long seconds;
55  long useconds;
56 };
57 
58 enum ssh_quote_state_e {
59  NO_QUOTE,
60  SINGLE_QUOTE,
61  DOUBLE_QUOTE
62 };
63 
64 struct ssh_list *ssh_list_new(void);
65 void ssh_list_free(struct ssh_list *list);
66 struct ssh_iterator *ssh_list_get_iterator(const struct ssh_list *list);
67 struct ssh_iterator *ssh_list_find(const struct ssh_list *list, void *value);
68 size_t ssh_list_count(const struct ssh_list *list);
69 int ssh_list_append(struct ssh_list *list, const void *data);
70 int ssh_list_prepend(struct ssh_list *list, const void *data);
71 void ssh_list_remove(struct ssh_list *list, struct ssh_iterator *iterator);
72 char *ssh_lowercase(const char* str);
73 char *ssh_hostport(const char *host, int port);
74 
75 const void *_ssh_list_pop_head(struct ssh_list *list);
76 
77 #define ssh_iterator_value(type, iterator)\
78  ((type)((iterator)->data))
79 
85 #define ssh_list_pop_head(type, ssh_list)\
86  ((type)_ssh_list_pop_head(ssh_list))
87 
88 int ssh_make_milliseconds(unsigned long sec, unsigned long usec);
89 void ssh_timestamp_init(struct ssh_timestamp *ts);
90 int ssh_timeout_elapsed(struct ssh_timestamp *ts, int timeout);
91 int ssh_timeout_update(struct ssh_timestamp *ts, int timeout);
92 
93 int ssh_match_group(const char *group, const char *object);
94 
95 void uint64_inc(unsigned char *counter);
96 
97 void ssh_log_hexdump(const char *descr, const unsigned char *what, size_t len);
98 
99 int ssh_mkdirs(const char *pathname, mode_t mode);
100 
101 int ssh_quote_file_name(const char *file_name, char *buf, size_t buf_len);
102 int ssh_newline_vis(const char *string, char *buf, size_t buf_len);
103 int ssh_tmpname(char *name);
104 
105 char *ssh_strreplace(const char *src, const char *pattern, const char *repl);
106 
107 int ssh_check_hostname_syntax(const char *hostname);
108 
109 #ifdef __cplusplus
110 }
111 #endif
112 
113 #endif /* MISC_H_ */
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:513
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:1043
size_t ssh_list_count(const struct ssh_list *list)
Get the number of elements in the list.
Definition: misc.c:755
int ssh_check_hostname_syntax(const char *hostname)
Checks syntax of a domain name.
Definition: misc.c:2028
char * ssh_path_expand_tilde(const char *d)
Expand a directory starting with a tilde '~'.
Definition: misc.c:1106
int ssh_timeout_update(struct ssh_timestamp *ts, int timeout)
updates a timeout value so it reflects the remaining time
Definition: misc.c:1549
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:308
Definition: misc.h:48
Definition: misc.h:43
Definition: session.h:127
Definition: misc.h:53