api.c escape required characters in return strings + pools returns the username
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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
diff --git a/README b/README
index ed71087..3232f87 100644
--- a/README
+++ b/README
@@ -596,6 +596,15 @@ An example request in both formats to set GPU 0 fan to 80%:
The format of each reply (unless stated otherwise) is a STATUS section
followed by an optional detail section
+From API verion 1.7 onwards, reply strings in JSON and Text have the
+necessary escaping as required to avoid ambiguity - they didn't before 1.7
+For JSON the 2 characters '"' and '\' are escaped with a '\' before them
+For Text the 4 characters '|' ',' '=' and '\' are escaped the same way
+
+Only user entered information will contain characters that require being
+escaped, such as Pool URL, User and Password or the Config save filename,
+when they are returned in messages or as their values by the API
+
For API version 1.4 and later:
The STATUS section is:
@@ -622,7 +631,7 @@ The STATUS section is:
This defaults to the cgminer version but is the value of --api-description
if it was specified at runtime.
-For API version 1.6:
+For API version 1.7:
The list of requests - a (*) means it requires privileged access - and replies are:
diff --git a/api.c b/api.c
index 953b193..ac2197c 100644
--- a/api.c
+++ b/api.c
@@ -157,7 +157,7 @@ static const char *COMMA = ",";
static const char SEPARATOR = '|';
static const char GPUSEP = ',';
-static const char *APIVERSION = "1.6";
+static const char *APIVERSION = "1.7";
static const char *DEAD = "Dead";
static const char *SICK = "Sick";
static const char *NOSTART = "NoStart";
@@ -483,6 +483,68 @@ extern struct device_api bitforce_api;
extern struct device_api icarus_api;
#endif
+// This is only called when expected to be needed (rarely)
+// i.e. strings outside of the codes control (input from the user)
+static char *escape_string(char *str, bool isjson)
+{
+ char *buf, *ptr;
+ int count;
+
+ count = 0;
+ for (ptr = str; *ptr; ptr++) {
+ switch (*ptr) {
+ case ',':
+ case '|':
+ case '=':
+ if (!isjson)
+ count++;
+ break;
+ case '"':
+ if (isjson)
+ count++;
+ break;
+ case '\\':
+ count++;
+ break;
+ }
+ }
+
+ if (count == 0)
+ return str;
+
+ buf = malloc(strlen(str) + count + 1);
+ if (unlikely(!buf))
+ quit(1, "Failed to malloc escape buf");
+
+ ptr = buf;
+ while (*str)
+ switch (*str) {
+ case ',':
+ case '|':
+ case '=':
+ if (!isjson)
+ *(ptr++) = '\\';
+ *(ptr++) = *(str++);
+ break;
+ case '"':
+ if (isjson)
+ *(ptr++) = '\\';
+ *(ptr++) = *(str++);
+ break;
+ case '\\':
+ *(ptr++) = '\\';
+ *(ptr++) = *(str++);
+ break;
+ default:
+ *(ptr++) = *(str++);
+ break;
+ }
+
+ *ptr = '\0';
+
+ return buf;
+}
+
#if defined(USE_BITFORCE) || defined(USE_ICARUS)
static int numpgas()
{
@@ -1102,6 +1164,8 @@ static void poolstatus(__maybe_unused SOCKETTYPE c, __maybe_unused char *param,
{
char buf[BUFSIZ];
char *status, *lp;
+ char *rpc_url;
+ char *rpc_user;
int i;
if (total_pools == 0) {
@@ -1133,27 +1197,40 @@ static void poolstatus(__maybe_unused SOCKETTYPE c, __maybe_unused char *param,
else
lp = (char *)NO;
+ rpc_url = escape_string(pool->rpc_url, isjson);
+ rpc_user = escape_string(pool->rpc_user, isjson);
+
if (isjson)
- sprintf(buf, "%s{\"POOL\":%d,\"URL\":\"%s\",\"Status\":\"%s\",\"Priority\":%d,\"Long Poll\":\"%s\",\"Getworks\":%d,\"Accepted\":%d,\"Rejected\":%d,\"Discarded\":%d,\"Stale\":%d,\"Get Failures\":%d,\"Remote Failures\":%d}",
+ sprintf(buf, "%s{\"POOL\":%d,\"URL\":\"%s\",\"Status\":\"%s\",\"Priority\":%d,\"Long Poll\":\"%s\",\"Getworks\":%d,\"Accepted\":%d,\"Rejected\":%d,\"Discarded\":%d,\"Stale\":%d,\"Get Failures\":%d,\"Remote Failures\":%d,\"User\":\"%s\"}",
(i > 0) ? COMMA : "",
- i, pool->rpc_url, status, pool->prio, lp,
+ i, rpc_url, status, pool->prio, lp,
pool->getwork_requested,
pool->accepted, pool->rejected,
pool->discarded_work,
pool->stale_shares,
pool->getfail_occasions,
- pool->remotefail_occasions);
+ pool->remotefail_occasions,
+ rpc_user);
else
- sprintf(buf, "POOL=%d,URL=%s,Status=%s,Priority=%d,Long Poll=%s,Getworks=%d,Accepted=%d,Rejected=%d,Discarded=%d,Stale=%d,Get Failures=%d,Remote Failures=%d%c",
- i, pool->rpc_url, status, pool->prio, lp,
+ sprintf(buf, "POOL=%d,URL=%s,Status=%s,Priority=%d,Long Poll=%s,Getworks=%d,Accepted=%d,Rejected=%d,Discarded=%d,Stale=%d,Get Failures=%d,Remote Failures=%d,User=%s%c",
+ i, rpc_url, status, pool->prio, lp,
pool->getwork_requested,
pool->accepted, pool->rejected,
pool->discarded_work,
pool->stale_shares,
pool->getfail_occasions,
- pool->remotefail_occasions, SEPARATOR);
+ pool->remotefail_occasions,
+ rpc_user, SEPARATOR);
strcat(io_buffer, buf);
+
+ if (rpc_url != pool->rpc_url)
+ free(rpc_url);
+ rpc_url = NULL;
+
+ if (rpc_user != pool->rpc_user)
+ free(rpc_user);
+ rpc_user = NULL;
}
if (isjson)
@@ -1443,6 +1520,7 @@ exitsama:
static void addpool(__maybe_unused SOCKETTYPE c, char *param, bool isjson)
{
char *url, *user, *pass;
+ char *ptr;
if (param == NULL || *param == '\0') {
strcpy(io_buffer, message(MSG_MISPDP, 0, NULL, isjson));
@@ -1450,7 +1528,11 @@ static void addpool(__maybe_unused SOCKETTYPE c, char *param, bool isjson)
}
if (!pooldetails(param, &url, &user, &pass)) {
- strcpy(io_buffer, message(MSG_INVPDP, 0, param, isjson));
+ ptr = escape_string(param, isjson);
+ strcpy(io_buffer, message(MSG_INVPDP, 0, ptr, isjson));
+ if (ptr != param)
+ free(ptr);
+ ptr = NULL;
return;
}
@@ -1459,7 +1541,11 @@ static void addpool(__maybe_unused SOCKETTYPE c, char *param, bool isjson)
return;
}
- strcpy(io_buffer, message(MSG_ADDPOOL, 0, url, isjson));
+ ptr = escape_string(url, isjson);
+ strcpy(io_buffer, message(MSG_ADDPOOL, 0, ptr, isjson));
+ if (ptr != url)
+ free(ptr);
+ ptr = NULL;
}
static void enablepool(__maybe_unused SOCKETTYPE c, char *param, bool isjson)
@@ -1792,6 +1878,7 @@ static void notify(__maybe_unused SOCKETTYPE c, __maybe_unused char *param, bool
void dosave(__maybe_unused SOCKETTYPE c, char *param, bool isjson)
{
FILE *fcfg;
+ char *ptr;
if (param == NULL || *param == '\0') {
strcpy(io_buffer, message(MSG_MISFN, 0, NULL, isjson));
@@ -1800,14 +1887,22 @@ void dosave(__maybe_unused SOCKETTYPE c, char *param, bool isjson)
fcfg = fopen(param, "w");
if (!fcfg) {
- strcpy(io_buffer, message(MSG_BADFN, 0, param, isjson));
+ ptr = escape_string(param, isjson);
+ strcpy(io_buffer, message(MSG_BADFN, 0, ptr, isjson));
+ if (ptr != param)
+ free(ptr);
+ ptr = NULL;
return;
}
write_config(fcfg);
fclose(fcfg);
- strcpy(io_buffer, message(MSG_SAVED, 0, param, isjson));
+ ptr = escape_string(param, isjson);
+ strcpy(io_buffer, message(MSG_SAVED, 0, ptr, isjson));
+ if (ptr != param)
+ free(ptr);
+ ptr = NULL;
}
struct CMDS {