mirror of
https://git.tartarus.org/simon/putty.git
synced 2025-07-01 03:22:48 -05:00
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as _almost_ completely separate types. I'm still willing to use C's implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine, no need to spell it out as blob.len != 0), but generally, if a variable is going to be conceptually a boolean, I like to declare it bool and assign to it using 'true' or 'false' rather than 0 or 1. PuTTY is an exception, because it predates the C99 bool, and I've stuck to its existing coding style even when adding new code to it. But it's been annoying me more and more, so now that I've decided C99 bool is an acceptable thing to require from our toolchain in the first place, here's a quite thorough trawl through the source doing 'boolification'. Many variables and function parameters are now typed as bool rather than int; many assignments of 0 or 1 to those variables are now spelled 'true' or 'false'. I managed this thorough conversion with the help of a custom clang plugin that I wrote to trawl the AST and apply heuristics to point out where things might want changing. So I've even managed to do a decent job on parts of the code I haven't looked at in years! To make the plugin's work easier, I pushed platform front ends generally in the direction of using standard 'bool' in preference to platform-specific boolean types like Windows BOOL or GTK's gboolean; I've left the platform booleans in places they _have_ to be for the platform APIs to work right, but variables only used by my own code have been converted wherever I found them. In a few places there are int values that look very like booleans in _most_ of the places they're used, but have a rarely-used third value, or a distinction between different nonzero values that most users don't care about. In these cases, I've _removed_ uses of 'true' and 'false' for the return values, to emphasise that there's something more subtle going on than a simple boolean answer: - the 'multisel' field in dialog.h's list box structure, for which the GTK front end in particular recognises a difference between 1 and 2 but nearly everything else treats as boolean - the 'urgent' parameter to plug_receive, where 1 vs 2 tells you something about the specific location of the urgent pointer, but most clients only care about 0 vs 'something nonzero' - the return value of wc_match, where -1 indicates a syntax error in the wildcard. - the return values from SSH-1 RSA-key loading functions, which use -1 for 'wrong passphrase' and 0 for all other failures (so any caller which already knows it's not loading an _encrypted private_ key can treat them as boolean) - term->esc_query, and the 'query' parameter in toggle_mode in terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h, but can also hold -1 for some other intervening character that we don't support. In a few places there's an integer that I haven't turned into a bool even though it really _can_ only take values 0 or 1 (and, as above, tried to make the call sites consistent in not calling those values true and false), on the grounds that I thought it would make it more confusing to imply that the 0 value was in some sense 'negative' or bad and the 1 positive or good: - the return value of plug_accepting uses the POSIXish convention of 0=success and nonzero=error; I think if I made it bool then I'd also want to reverse its sense, and that's a job for a separate piece of work. - the 'screen' parameter to lineptr() in terminal.c, where 0 and 1 represent the default and alternate screens. There's no obvious reason why one of those should be considered 'true' or 'positive' or 'success' - they're just indices - so I've left it as int. ssh_scp_recv had particularly confusing semantics for its previous int return value: its call sites used '<= 0' to check for error, but it never actually returned a negative number, just 0 or 1. Now the function and its call sites agree that it's a bool. In a couple of places I've renamed variables called 'ret', because I don't like that name any more - it's unclear whether it means the return value (in preparation) for the _containing_ function or the return value received from a subroutine call, and occasionally I've accidentally used the same variable for both and introduced a bug. So where one of those got in my way, I've renamed it to 'toret' or 'retd' (the latter short for 'returned') in line with my usual modern practice, but I haven't done a thorough job of finding all of them. Finally, one amusing side effect of doing this is that I've had to separate quite a few chained assignments. It used to be perfectly fine to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a the 'true' defined by stdbool.h, that idiom provokes a warning from gcc: 'suggest parentheses around assignment used as truth value'!
This commit is contained in:
Simon Tatham
117
import.c
117
import.c
@ -12,39 +12,39 @@
|
||||
#include "ssh.h"
|
||||
#include "misc.h"
|
||||
|
||||
int openssh_pem_encrypted(const Filename *filename);
|
||||
int openssh_new_encrypted(const Filename *filename);
|
||||
bool openssh_pem_encrypted(const Filename *filename);
|
||||
bool openssh_new_encrypted(const Filename *filename);
|
||||
struct ssh2_userkey *openssh_pem_read(const Filename *filename,
|
||||
char *passphrase,
|
||||
const char **errmsg_p);
|
||||
struct ssh2_userkey *openssh_new_read(const Filename *filename,
|
||||
char *passphrase,
|
||||
const char **errmsg_p);
|
||||
int openssh_auto_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
bool openssh_auto_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
bool openssh_pem_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
bool openssh_new_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
int openssh_pem_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
int openssh_new_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
|
||||
int sshcom_encrypted(const Filename *filename, char **comment);
|
||||
bool sshcom_encrypted(const Filename *filename, char **comment);
|
||||
struct ssh2_userkey *sshcom_read(const Filename *filename, char *passphrase,
|
||||
const char **errmsg_p);
|
||||
int sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
bool sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase);
|
||||
|
||||
/*
|
||||
* Given a key type, determine whether we know how to import it.
|
||||
*/
|
||||
int import_possible(int type)
|
||||
bool import_possible(int type)
|
||||
{
|
||||
if (type == SSH_KEYTYPE_OPENSSH_PEM)
|
||||
return 1;
|
||||
return true;
|
||||
if (type == SSH_KEYTYPE_OPENSSH_NEW)
|
||||
return 1;
|
||||
return true;
|
||||
if (type == SSH_KEYTYPE_SSHCOM)
|
||||
return 1;
|
||||
return 0;
|
||||
return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
@ -63,7 +63,7 @@ int import_target_type(int type)
|
||||
/*
|
||||
* Determine whether a foreign key is encrypted.
|
||||
*/
|
||||
int import_encrypted(const Filename *filename, int type, char **comment)
|
||||
bool import_encrypted(const Filename *filename, int type, char **comment)
|
||||
{
|
||||
if (type == SSH_KEYTYPE_OPENSSH_PEM) {
|
||||
/* OpenSSH PEM format doesn't contain a key comment at all */
|
||||
@ -77,7 +77,7 @@ int import_encrypted(const Filename *filename, int type, char **comment)
|
||||
} else if (type == SSH_KEYTYPE_SSHCOM) {
|
||||
return sshcom_encrypted(filename, comment);
|
||||
}
|
||||
return 0;
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
@ -107,17 +107,17 @@ struct ssh2_userkey *import_ssh2(const Filename *filename, int type,
|
||||
/*
|
||||
* Export an SSH-1 key.
|
||||
*/
|
||||
int export_ssh1(const Filename *filename, int type, struct RSAKey *key,
|
||||
char *passphrase)
|
||||
bool export_ssh1(const Filename *filename, int type, struct RSAKey *key,
|
||||
char *passphrase)
|
||||
{
|
||||
return 0;
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
* Export an SSH-2 key.
|
||||
*/
|
||||
int export_ssh2(const Filename *filename, int type,
|
||||
struct ssh2_userkey *key, char *passphrase)
|
||||
bool export_ssh2(const Filename *filename, int type,
|
||||
struct ssh2_userkey *key, char *passphrase)
|
||||
{
|
||||
if (type == SSH_KEYTYPE_OPENSSH_AUTO)
|
||||
return openssh_auto_write(filename, key, passphrase);
|
||||
@ -125,7 +125,7 @@ int export_ssh2(const Filename *filename, int type,
|
||||
return openssh_new_write(filename, key, passphrase);
|
||||
if (type == SSH_KEYTYPE_SSHCOM)
|
||||
return sshcom_write(filename, key, passphrase);
|
||||
return 0;
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
@ -276,7 +276,7 @@ typedef enum {
|
||||
|
||||
struct openssh_pem_key {
|
||||
openssh_pem_keytype keytype;
|
||||
int encrypted;
|
||||
bool encrypted;
|
||||
openssh_pem_enc encryption;
|
||||
char iv[32];
|
||||
strbuf *keyblob;
|
||||
@ -309,7 +309,7 @@ static struct openssh_pem_key *load_openssh_pem_key(const Filename *filename,
|
||||
char *line = NULL;
|
||||
const char *errmsg;
|
||||
char *p;
|
||||
int headers_done;
|
||||
bool headers_done;
|
||||
char base64_bit[4];
|
||||
int base64_chars = 0;
|
||||
|
||||
@ -358,7 +358,7 @@ static struct openssh_pem_key *load_openssh_pem_key(const Filename *filename,
|
||||
ret->encrypted = false;
|
||||
memset(ret->iv, 0, sizeof(ret->iv));
|
||||
|
||||
headers_done = 0;
|
||||
headers_done = false;
|
||||
while (1) {
|
||||
if (!(line = fgetline(fp))) {
|
||||
errmsg = "unexpected end of file";
|
||||
@ -415,7 +415,7 @@ static struct openssh_pem_key *load_openssh_pem_key(const Filename *filename,
|
||||
}
|
||||
}
|
||||
} else {
|
||||
headers_done = 1;
|
||||
headers_done = true;
|
||||
|
||||
p = line;
|
||||
while (isbase64(*p)) {
|
||||
@ -482,13 +482,13 @@ static struct openssh_pem_key *load_openssh_pem_key(const Filename *filename,
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int openssh_pem_encrypted(const Filename *filename)
|
||||
bool openssh_pem_encrypted(const Filename *filename)
|
||||
{
|
||||
struct openssh_pem_key *key = load_openssh_pem_key(filename, NULL);
|
||||
int ret;
|
||||
bool ret;
|
||||
|
||||
if (!key)
|
||||
return 0;
|
||||
return false;
|
||||
ret = key->encrypted;
|
||||
strbuf_free(key->keyblob);
|
||||
smemclr(key, sizeof(*key));
|
||||
@ -775,8 +775,8 @@ struct ssh2_userkey *openssh_pem_read(const Filename *filename,
|
||||
return retval;
|
||||
}
|
||||
|
||||
int openssh_pem_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
bool openssh_pem_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
{
|
||||
strbuf *pubblob, *privblob, *outblob;
|
||||
unsigned char *spareblob;
|
||||
@ -786,7 +786,7 @@ int openssh_pem_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
const char *header, *footer;
|
||||
char zero[1];
|
||||
unsigned char iv[8];
|
||||
int ret = 0;
|
||||
bool ret = false;
|
||||
FILE *fp;
|
||||
BinarySource src[1];
|
||||
|
||||
@ -1061,7 +1061,7 @@ int openssh_pem_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
base64_encode(fp, outblob->u, outblob->len, 64);
|
||||
fputs(footer, fp);
|
||||
fclose(fp);
|
||||
ret = 1;
|
||||
ret = true;
|
||||
|
||||
error:
|
||||
if (outblob)
|
||||
@ -1319,13 +1319,13 @@ static struct openssh_new_key *load_openssh_new_key(const Filename *filename,
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int openssh_new_encrypted(const Filename *filename)
|
||||
bool openssh_new_encrypted(const Filename *filename)
|
||||
{
|
||||
struct openssh_new_key *key = load_openssh_new_key(filename, NULL);
|
||||
int ret;
|
||||
bool ret;
|
||||
|
||||
if (!key)
|
||||
return 0;
|
||||
return false;
|
||||
ret = (key->cipher != ON_E_NONE);
|
||||
smemclr(key->keyblob, key->keyblob_size);
|
||||
sfree(key->keyblob);
|
||||
@ -1515,13 +1515,13 @@ struct ssh2_userkey *openssh_new_read(const Filename *filename,
|
||||
return retval;
|
||||
}
|
||||
|
||||
int openssh_new_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
bool openssh_new_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
{
|
||||
strbuf *pubblob, *privblob, *cblob;
|
||||
int padvalue, i;
|
||||
unsigned checkint;
|
||||
int ret = 0;
|
||||
bool ret = false;
|
||||
unsigned char bcrypt_salt[16];
|
||||
const int bcrypt_rounds = 16;
|
||||
FILE *fp;
|
||||
@ -1628,7 +1628,7 @@ int openssh_new_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
base64_encode(fp, cblob->u, cblob->len, 64);
|
||||
fputs("-----END OPENSSH PRIVATE KEY-----\n", fp);
|
||||
fclose(fp);
|
||||
ret = 1;
|
||||
ret = true;
|
||||
|
||||
error:
|
||||
if (cblob)
|
||||
@ -1644,8 +1644,8 @@ int openssh_new_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
* The switch function openssh_auto_write(), which chooses one of the
|
||||
* concrete OpenSSH output formats based on the key type.
|
||||
*/
|
||||
int openssh_auto_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
bool openssh_auto_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
{
|
||||
/*
|
||||
* The old OpenSSH format supports a fixed list of key types. We
|
||||
@ -1753,7 +1753,7 @@ static struct sshcom_key *load_sshcom_key(const Filename *filename,
|
||||
int hdrstart, len;
|
||||
const char *errmsg;
|
||||
char *p;
|
||||
int headers_done;
|
||||
bool headers_done;
|
||||
char base64_bit[4];
|
||||
int base64_chars = 0;
|
||||
|
||||
@ -1780,7 +1780,7 @@ static struct sshcom_key *load_sshcom_key(const Filename *filename,
|
||||
sfree(line);
|
||||
line = NULL;
|
||||
|
||||
headers_done = 0;
|
||||
headers_done = false;
|
||||
while (1) {
|
||||
if (!(line = fgetline(fp))) {
|
||||
errmsg = "unexpected end of file";
|
||||
@ -1840,7 +1840,7 @@ static struct sshcom_key *load_sshcom_key(const Filename *filename,
|
||||
ret->comment[sizeof(ret->comment)-1] = '\0';
|
||||
}
|
||||
} else {
|
||||
headers_done = 1;
|
||||
headers_done = true;
|
||||
|
||||
p = line;
|
||||
while (isbase64(*p)) {
|
||||
@ -1905,12 +1905,12 @@ static struct sshcom_key *load_sshcom_key(const Filename *filename,
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int sshcom_encrypted(const Filename *filename, char **comment)
|
||||
bool sshcom_encrypted(const Filename *filename, char **comment)
|
||||
{
|
||||
struct sshcom_key *key = load_sshcom_key(filename, NULL);
|
||||
BinarySource src[1];
|
||||
ptrlen str;
|
||||
int answer = false;
|
||||
bool answer = false;
|
||||
|
||||
*comment = NULL;
|
||||
if (!key)
|
||||
@ -1981,7 +1981,7 @@ struct ssh2_userkey *sshcom_read(const Filename *filename, char *passphrase,
|
||||
const char prefix_rsa[] = "if-modn{sign{rsa";
|
||||
const char prefix_dsa[] = "dl-modp{sign{dsa";
|
||||
enum { RSA, DSA } type;
|
||||
int encrypted;
|
||||
bool encrypted;
|
||||
struct ssh2_userkey *ret = NULL, *retkey;
|
||||
const ssh_keyalg *alg;
|
||||
strbuf *blob = NULL;
|
||||
@ -2017,9 +2017,9 @@ struct ssh2_userkey *sshcom_read(const Filename *filename, char *passphrase,
|
||||
*/
|
||||
str = get_string(src);
|
||||
if (ptrlen_eq_string(str, "none"))
|
||||
encrypted = 0;
|
||||
encrypted = false;
|
||||
else if (ptrlen_eq_string(str, "3des-cbc"))
|
||||
encrypted = 1;
|
||||
encrypted = true;
|
||||
else {
|
||||
errmsg = "key encryption is of unknown type";
|
||||
goto error;
|
||||
@ -2181,17 +2181,18 @@ struct ssh2_userkey *sshcom_read(const Filename *filename, char *passphrase,
|
||||
return ret;
|
||||
}
|
||||
|
||||
int sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
bool sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
char *passphrase)
|
||||
{
|
||||
strbuf *pubblob, *privblob, *outblob;
|
||||
ptrlen numbers[6];
|
||||
int nnumbers, initial_zero, lenpos, i;
|
||||
int nnumbers, lenpos, i;
|
||||
bool initial_zero;
|
||||
BinarySource src[1];
|
||||
const char *type;
|
||||
char *ciphertext;
|
||||
int cipherlen;
|
||||
int ret = 0;
|
||||
bool ret = false;
|
||||
FILE *fp;
|
||||
|
||||
/*
|
||||
@ -2234,7 +2235,7 @@ int sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
numbers[5] = p;
|
||||
|
||||
nnumbers = 6;
|
||||
initial_zero = 0;
|
||||
initial_zero = false;
|
||||
type = "if-modn{sign{rsa-pkcs1-sha1},encrypt{rsa-pkcs1v2-oaep}}";
|
||||
} else if (ssh_key_alg(key->key) == &ssh_dss) {
|
||||
ptrlen p, q, g, y, x;
|
||||
@ -2261,7 +2262,7 @@ int sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
numbers[4] = x;
|
||||
|
||||
nnumbers = 5;
|
||||
initial_zero = 1;
|
||||
initial_zero = true;
|
||||
type = "dl-modp{sign{dsa-nist-sha1},dh{plain}}";
|
||||
} else {
|
||||
goto error; /* unsupported key type */
|
||||
@ -2362,7 +2363,7 @@ int sshcom_write(const Filename *filename, struct ssh2_userkey *key,
|
||||
base64_encode(fp, outblob->u, outblob->len, 70);
|
||||
fputs("---- END SSH2 ENCRYPTED PRIVATE KEY ----\n", fp);
|
||||
fclose(fp);
|
||||
ret = 1;
|
||||
ret = true;
|
||||
|
||||
error:
|
||||
if (outblob)
|
||||
|
||||
Reference in New Issue
Block a user