libssh  0.10.90
The SSH library
Loading...
Searching...
No Matches
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 _WIN32
25
26# ifdef _MSC_VER
27# ifndef _SSIZE_T_DEFINED
28# undef ssize_t
29# include <BaseTsd.h>
30 typedef _W64 SSIZE_T ssize_t;
31# define _SSIZE_T_DEFINED
32# endif /* _SSIZE_T_DEFINED */
33# endif /* _MSC_VER */
34
35#else
36# include <sys/types.h>
37#endif /* _WIN32 */
38
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43/* in misc.c */
44/* gets the user home dir. */
45char *ssh_get_user_home_dir(void);
46char *ssh_get_local_username(void);
47int ssh_file_readaccess_ok(const char *file);
48int ssh_dir_writeable(const char *path);
49
50char *ssh_path_expand_tilde(const char *d);
51char *ssh_path_expand_escape(ssh_session session, const char *s);
52int ssh_analyze_banner(ssh_session session, int server);
53int ssh_is_ipaddr_v4(const char *str);
54int ssh_is_ipaddr(const char *str);
55
56/* list processing */
57
58struct ssh_list {
59 struct ssh_iterator *root;
60 struct ssh_iterator *end;
61};
62
63struct ssh_iterator {
64 struct ssh_iterator *next;
65 const void *data;
66};
67
68struct ssh_timestamp {
69 long seconds;
70 long useconds;
71};
72
73enum ssh_quote_state_e {
74 NO_QUOTE,
75 SINGLE_QUOTE,
76 DOUBLE_QUOTE
77};
78
79struct ssh_list *ssh_list_new(void);
80void ssh_list_free(struct ssh_list *list);
81struct ssh_iterator *ssh_list_get_iterator(const struct ssh_list *list);
82struct ssh_iterator *ssh_list_find(const struct ssh_list *list, void *value);
83size_t ssh_list_count(const struct ssh_list *list);
84int ssh_list_append(struct ssh_list *list, const void *data);
85int ssh_list_prepend(struct ssh_list *list, const void *data);
86void ssh_list_remove(struct ssh_list *list, struct ssh_iterator *iterator);
87char *ssh_lowercase(const char* str);
88char *ssh_hostport(const char *host, int port);
89
90const void *_ssh_list_pop_head(struct ssh_list *list);
91
92#define ssh_iterator_value(type, iterator)\
93 ((type)((iterator)->data))
94
100#define ssh_list_pop_head(type, ssh_list)\
101 ((type)_ssh_list_pop_head(ssh_list))
102
103int ssh_make_milliseconds(unsigned long sec, unsigned long usec);
104void ssh_timestamp_init(struct ssh_timestamp *ts);
105int ssh_timeout_elapsed(struct ssh_timestamp *ts, int timeout);
106int ssh_timeout_update(struct ssh_timestamp *ts, int timeout);
107
108int ssh_match_group(const char *group, const char *object);
109
110void uint64_inc(unsigned char *counter);
111
112void ssh_log_hexdump(const char *descr, const unsigned char *what, size_t len);
113
114int ssh_mkdirs(const char *pathname, mode_t mode);
115
116int ssh_quote_file_name(const char *file_name, char *buf, size_t buf_len);
117int ssh_newline_vis(const char *string, char *buf, size_t buf_len);
118int ssh_tmpname(char *name);
119
120char *ssh_strreplace(const char *src, const char *pattern, const char *repl);
121
122ssize_t ssh_readn(int fd, void *buf, size_t nbytes);
123ssize_t ssh_writen(int fd, const void *buf, size_t nbytes);
124
125int ssh_check_hostname_syntax(const char *hostname);
126int ssh_check_username_syntax(const char *username);
127
128#ifdef __cplusplus
129}
130#endif
131
132#endif /* MISC_H_ */
ssize_t ssh_writen(int fd, const void *buf, size_t nbytes)
Write the requested number of bytes to a local file.
Definition misc.c:2103
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:521
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:1053
ssize_t ssh_readn(int fd, void *buf, size_t nbytes)
Read the requested number of bytes from a local file.
Definition misc.c:2047
size_t ssh_list_count(const struct ssh_list *list)
Get the number of elements in the list.
Definition misc.c:764
int ssh_check_hostname_syntax(const char *hostname)
Checks syntax of a domain name.
Definition misc.c:2149
char * ssh_path_expand_tilde(const char *d)
Expand a directory starting with a tilde '~'.
Definition misc.c:1116
int ssh_check_username_syntax(const char *username)
Checks syntax of a username.
Definition misc.c:2208
int ssh_timeout_update(struct ssh_timestamp *ts, int timeout)
updates a timeout value so it reflects the remaining time
Definition misc.c:1559
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:314