libssh: /build/libssh/src/libssh-0.9.0/include/libssh/config_parser.h Source File

libssh 0.9.0 The SSH library

config_parser.h
1 /*
2 * config_parser.h - Common configuration file parser functions
3 *
4 * This file is part of the SSH Library
5 *
6 * Copyright (c) 2019 by Red Hat, Inc.
7 *
8 * Author: Anderson Toshiyuki Sasaki <ansasaki@redhat.com>
9 *
10 * The SSH Library is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or (at your
13 * option) any later version.
14 *
15 * The SSH Library is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
18 * License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with the SSH Library; see the file COPYING. If not, write to
22 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
23 * MA 02111-1307, USA.
24 */
25
26 #ifndef CONFIG_PARSER_H_
27 #define CONFIG_PARSER_H_
28
29 char *ssh_config_get_cmd(char **str);
30
31 char *ssh_config_get_token(char **str);
32
33 long ssh_config_get_long(char **str, long notfound);
34
35 const char *ssh_config_get_str_tok(char **str, const char *def);
36
37 int ssh_config_get_yesno(char **str, int notfound);
38
39 /* @brief Parse SSH URI in format [user@]host[:port] from the given string
40 *
41 * @param[in] tok String to parse
42 * @param[out] username Pointer to the location, where the new username will
43 * be stored or NULL if we do not care about the result.
44 * @param[out] hostname Pointer to the location, where the new hostname will
45 * be stored or NULL if we do not care about the result.
46 * @param[out] port Pointer to the location, where the new port will
47 * be stored or NULL if we do not care about the result.
48 *
49 * @returns SSH_OK if the provided string is in format of SSH URI,
50 * SSH_ERROR on failure
51 */
52 int ssh_config_parse_uri(const char *tok,
53 char **username,
54 char **hostname,
55 char **port);
56
57 #endif /* LIBSSH_CONFIG_H_ */