1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/* Copyright (c) 2001 Matej Pfajfar.
* Copyright (c) 2001-2004, Roger Dingledine.
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
* Copyright (c) 2007-2020, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file control_cmd.h
* \brief Header file for control_cmd.c.
**/
#ifndef TOR_CONTROL_CMD_H
#define TOR_CONTROL_CMD_H
#include "lib/malloc/malloc.h"
int handle_control_command(control_connection_t *conn,
uint32_t cmd_data_len,
char *args);
void control_cmd_free_all(void);
typedef struct control_cmd_args_t control_cmd_args_t;
void control_cmd_args_free_(control_cmd_args_t *args);
void control_cmd_args_wipe(control_cmd_args_t *args);
#define control_cmd_args_free(v) \
FREE_AND_NULL(control_cmd_args_t, control_cmd_args_free_, (v))
/**
* Definition for the syntax of a controller command, as parsed by
* control_cmd_parse_args.
*
* WORK IN PROGRESS: This structure is going to get more complex as this
* branch goes on.
**/
typedef struct control_cmd_syntax_t {
/**
* Lowest number of positional arguments that this command accepts.
* 0 for "it's okay not to have positional arguments."
**/
unsigned int min_args;
/**
* Highest number of positional arguments that this command accepts.
* UINT_MAX for no limit.
**/
unsigned int max_args;
/**
* If true, we should parse options after the positional arguments
* as a set of unordered flags and key=value arguments.
*
* Requires that max_args is not UINT_MAX.
**/
bool accept_keywords;
/**
* If accept_keywords is true, then only the keywords listed in this
* (NULL-terminated) array are valid keywords for this command.
**/
const char **allowed_keywords;
/**
* If accept_keywords is true, this option is passed to kvline_parse() as
* its flags.
**/
unsigned kvline_flags;
/**
* True iff this command wants to be followed by a multiline object.
**/
bool want_cmddata;
/**
* True iff this command needs access to the raw body of the input.
*
* This should not be needed for pure commands; it is purely a legacy
* option.
**/
bool store_raw_body;
} control_cmd_syntax_t;
#ifdef CONTROL_CMD_PRIVATE
#include "lib/crypt_ops/crypto_ed25519.h"
/* ADD_ONION secret key to create an ephemeral service. The command supports
* multiple versions so this union stores the key and passes it to the HS
* subsystem depending on the requested version. */
typedef union add_onion_secret_key_t {
/* Hidden service v2 secret key. */
crypto_pk_t *v2;
/* Hidden service v3 secret key. */
ed25519_secret_key_t *v3;
} add_onion_secret_key_t;
STATIC int add_onion_helper_keyarg(const char *arg, int discard_pk,
const char **key_new_alg_out,
char **key_new_blob_out,
add_onion_secret_key_t *decoded_key,
int *hs_version,
control_connection_t *conn);
STATIC rend_authorized_client_t *add_onion_helper_clientauth(const char *arg,
int *created, control_connection_t *conn);
STATIC control_cmd_args_t *control_cmd_parse_args(
const char *command,
const control_cmd_syntax_t *syntax,
size_t body_len,
const char *body,
char **error_out);
#endif /* defined(CONTROL_CMD_PRIVATE) */
#ifdef CONTROL_MODULE_PRIVATE
smartlist_t * get_detached_onion_services(void);
#endif /* defined(CONTROL_MODULE_PRIVATE) */
#endif /* !defined(TOR_CONTROL_CMD_H) */
|
