Extract nickname-checking functions from router.c

This commit is contained in:
Nick Mathewson 2018-09-25 16:22:11 -04:00
parent 5c86f3c297
commit efa978124f
6 changed files with 89 additions and 52 deletions

View File

@ -93,6 +93,7 @@ LIBTOR_APP_A_SOURCES = \
src/feature/nodelist/dirlist.c \ src/feature/nodelist/dirlist.c \
src/feature/nodelist/microdesc.c \ src/feature/nodelist/microdesc.c \
src/feature/nodelist/networkstatus.c \ src/feature/nodelist/networkstatus.c \
src/feature/nodelist/nickname.c \
src/feature/nodelist/nodelist.c \ src/feature/nodelist/nodelist.c \
src/feature/nodelist/node_select.c \ src/feature/nodelist/node_select.c \
src/feature/nodelist/parsecommon.c \ src/feature/nodelist/parsecommon.c \
@ -309,6 +310,7 @@ noinst_HEADERS += \
src/feature/nodelist/networkstatus_sr_info_st.h \ src/feature/nodelist/networkstatus_sr_info_st.h \
src/feature/nodelist/networkstatus_st.h \ src/feature/nodelist/networkstatus_st.h \
src/feature/nodelist/networkstatus_voter_info_st.h \ src/feature/nodelist/networkstatus_voter_info_st.h \
src/feature/nodelist/nickname.h \
src/feature/nodelist/node_st.h \ src/feature/nodelist/node_st.h \
src/feature/nodelist/nodelist.h \ src/feature/nodelist/nodelist.h \
src/feature/nodelist/node_select.h \ src/feature/nodelist/node_select.h \

View File

@ -4,6 +4,11 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */ * Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */ /* See LICENSE for licensing information */
/**
* \file describe.c
* \brief Format short descriptions of relays.
*/
#include "core/or/or.h" #include "core/or/or.h"
#include "feature/nodelist/describe.h" #include "feature/nodelist/describe.h"
#include "feature/relay/router.h" #include "feature/relay/router.h"

View File

@ -0,0 +1,62 @@
/* Copyright (c) 2001 Matej Pfajfar.
* Copyright (c) 2001-2004, Roger Dingledine.
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file nickname.c
* \brief Check and manipulate relay nicknames.
*/
#include "core/or/or.h"
#include "feature/nodelist/nickname.h"
/** Return true iff <b>s</b> is a valid server nickname. (That is, a string
* containing between 1 and MAX_NICKNAME_LEN characters from
* LEGAL_NICKNAME_CHARACTERS.) */
int
is_legal_nickname(const char *s)
{
size_t len;
tor_assert(s);
len = strlen(s);
return len > 0 && len <= MAX_NICKNAME_LEN &&
strspn(s,LEGAL_NICKNAME_CHARACTERS) == len;
}
/** Return true iff <b>s</b> is a valid server nickname or
* hex-encoded identity-key digest. */
int
is_legal_nickname_or_hexdigest(const char *s)
{
if (*s!='$')
return is_legal_nickname(s);
else
return is_legal_hexdigest(s);
}
/** Return true iff <b>s</b> is a valid hex-encoded identity-key
* digest. (That is, an optional $, followed by 40 hex characters,
* followed by either nothing, or = or ~ followed by a nickname, or
* a character other than =, ~, or a hex character.)
*/
int
is_legal_hexdigest(const char *s)
{
size_t len;
tor_assert(s);
if (s[0] == '$') s++;
len = strlen(s);
if (len > HEX_DIGEST_LEN) {
if (s[HEX_DIGEST_LEN] == '=' ||
s[HEX_DIGEST_LEN] == '~') {
if (!is_legal_nickname(s+HEX_DIGEST_LEN+1))
return 0;
} else {
return 0;
}
}
return (len >= HEX_DIGEST_LEN &&
strspn(s,HEX_CHARACTERS)==HEX_DIGEST_LEN);
}

View File

@ -0,0 +1,19 @@
/* Copyright (c) 2001 Matej Pfajfar.
* Copyright (c) 2001-2004, Roger Dingledine.
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* \file nickname.h
* \brief Header file for nickname.c.
**/
#ifndef TOR_NICKNAME_H
#define TOR_NICKNAME_H
int is_legal_nickname(const char *s);
int is_legal_nickname_or_hexdigest(const char *s);
int is_legal_hexdigest(const char *s);
#endif

View File

@ -3104,55 +3104,6 @@ extrainfo_dump_to_string(char **s_out, extrainfo_t *extrainfo,
return result; return result;
} }
/** Return true iff <b>s</b> is a valid server nickname. (That is, a string
* containing between 1 and MAX_NICKNAME_LEN characters from
* LEGAL_NICKNAME_CHARACTERS.) */
int
is_legal_nickname(const char *s)
{
size_t len;
tor_assert(s);
len = strlen(s);
return len > 0 && len <= MAX_NICKNAME_LEN &&
strspn(s,LEGAL_NICKNAME_CHARACTERS) == len;
}
/** Return true iff <b>s</b> is a valid server nickname or
* hex-encoded identity-key digest. */
int
is_legal_nickname_or_hexdigest(const char *s)
{
if (*s!='$')
return is_legal_nickname(s);
else
return is_legal_hexdigest(s);
}
/** Return true iff <b>s</b> is a valid hex-encoded identity-key
* digest. (That is, an optional $, followed by 40 hex characters,
* followed by either nothing, or = or ~ followed by a nickname, or
* a character other than =, ~, or a hex character.)
*/
int
is_legal_hexdigest(const char *s)
{
size_t len;
tor_assert(s);
if (s[0] == '$') s++;
len = strlen(s);
if (len > HEX_DIGEST_LEN) {
if (s[HEX_DIGEST_LEN] == '=' ||
s[HEX_DIGEST_LEN] == '~') {
if (!is_legal_nickname(s+HEX_DIGEST_LEN+1))
return 0;
} else {
return 0;
}
}
return (len >= HEX_DIGEST_LEN &&
strspn(s,HEX_CHARACTERS)==HEX_DIGEST_LEN);
}
/** Forget that we have issued any router-related warnings, so that we'll /** Forget that we have issued any router-related warnings, so that we'll
* warn again if we see the same errors. */ * warn again if we see the same errors. */
void void

View File

@ -14,6 +14,7 @@
#include "lib/testsupport/testsupport.h" #include "lib/testsupport/testsupport.h"
#include "feature/nodelist/describe.h" #include "feature/nodelist/describe.h"
#include "feature/nodelist/nickname.h"
struct curve25519_keypair_t; struct curve25519_keypair_t;
struct ed25519_keypair_t; struct ed25519_keypair_t;
@ -119,9 +120,6 @@ int router_has_orport(const routerinfo_t *router,
int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo, int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
crypto_pk_t *ident_key, crypto_pk_t *ident_key,
const struct ed25519_keypair_t *signing_keypair); const struct ed25519_keypair_t *signing_keypair);
int is_legal_nickname(const char *s);
int is_legal_nickname_or_hexdigest(const char *s);
int is_legal_hexdigest(const char *s);
const char *routerinfo_err_to_string(int err); const char *routerinfo_err_to_string(int err);
int routerinfo_err_is_transient(int err); int routerinfo_err_is_transient(int err);