- tor-commits - lists.torproject.org

[vidalia/alpha] Fix segfault when having a problem applying a setting
by chiiph＠torproject.org 04 Jul '12

04 Jul '12

commit 01bec8f678dfde6c3129a00ec776156b150cdf23 Author: Tomás Touceda <chiiph(a)torproject.org> Date: Wed Jul 4 19:12:05 2012 -0300 Fix segfault when having a problem applying a setting --- src/vidalia/config/torrc/Torrc.cpp | 6 ++++-- 1 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/vidalia/config/torrc/Torrc.cpp b/src/vidalia/config/torrc/Torrc.cpp index 8a7be47..7fa0333 100644 --- a/src/vidalia/config/torrc/Torrc.cpp +++ b/src/vidalia/config/torrc/Torrc.cpp @@ -46,7 +46,8 @@ Torrc::apply(TorControl *tc, QString *errmsg) QFileInfo torrc_info(torrc); if(!torrc.open(QIODevice::WriteOnly)) { - *errmsg = "Couldn't open torrc file"; + if (errmsg) + *errmsg = "Couldn't open torrc file"; return false; } @@ -96,7 +97,8 @@ Torrc::apply(TorControl *tc, QString *errmsg) .arg(key).arg(ferrmsg)); somefailed = true; } else { - *errmsg = ferrmsg; + if (errmsg) + *errmsg = ferrmsg; return false; } }

1 0

[vidalia/alpha] Add base16_decode implementation based on tor's
by chiiph＠torproject.org 04 Jul '12

04 Jul '12

commit 528205043ebc7cbb001c647cd3dcc1377e648647 Author: Tomás Touceda <chiiph(a)torproject.org> Date: Wed Jul 4 21:09:56 2012 -0300 Add base16_decode implementation based on tor's --- src/common/stringutil.cpp | 47 +++++++++++++++++++++++++++++++++++++++++++++ src/common/stringutil.h | 1 + 2 files changed, 48 insertions(+), 0 deletions(-) diff --git a/src/common/stringutil.cpp b/src/common/stringutil.cpp index 8b9b64d..9ce9dbd 100644 --- a/src/common/stringutil.cpp +++ b/src/common/stringutil.cpp @@ -122,6 +122,53 @@ base16_encode(const QByteArray &buf) return hex; } +/** Helper: given a hex digit, return its value, or -1 if it isn't hex. */ +inline int +_hex_decode_digit(char c) +{ + switch (c) { + case '0': return 0; + case '1': return 1; + case '2': return 2; + case '3': return 3; + case '4': return 4; + case '5': return 5; + case '6': return 6; + case '7': return 7; + case '8': return 8; + case '9': return 9; + case 'A': case 'a': return 10; + case 'B': case 'b': return 11; + case 'C': case 'c': return 12; + case 'D': case 'd': return 13; + case 'E': case 'e': return 14; + case 'F': case 'f': return 15; + default: + return -1; + } +} + +/** Given a hexadecimal string of srclen bytes in src, decode it + * and store the result in the destlen-byte buffer at dest. + * Return 0 on success, -1 on failure. */ +QString +base16_decode(const QByteArray &buf) +{ + int v1,v2; + QString dest; + + if ((buf.size() % 2) != 0) + return QString(); + for(int i = 0; i < buf.size(); i+=2) { + v1 = _hex_decode_digit(buf[i]); + v2 = _hex_decode_digit(buf[i+1]); + if (v1<0||v2<0) + return QString(); + dest.append((v1<<4)|v2); + } + return dest; +} + /** Given an ASCII string str, this function returns a quoted string * with all escaped characters unescaped. Non-ASCII characters in the string * will be converted to the local 8-bit character encoding and encoded using diff --git a/src/common/stringutil.h b/src/common/stringutil.h index 24cac74..0e2f9fe 100644 --- a/src/common/stringutil.h +++ b/src/common/stringutil.h @@ -47,6 +47,7 @@ QString string_wrap(const QString &str, int width, * returns the result. This function is derived from base16_encode() in Tor's * util.c. See LICENSE for details on Tor's license. */ QString base16_encode(const QByteArray &buf); +QString base16_decode(const QByteArray &buf); /** Given a string str, this function returns a quoted string with all * '"' and '\' characters escaped with a single '\'. */

1 0

[vidalia/alpha] Implement SafeCookie authentication
by chiiph＠torproject.org 04 Jul '12

04 Jul '12

commit 34d524b6f994d27f4df243f422eed493a5226b0c Author: Tomás Touceda <chiiph(a)torproject.org> Date: Wed Jul 4 21:10:55 2012 -0300 Implement SafeCookie authentication --- changes/bug5855 | 3 + src/torcontrol/TorControl.cpp | 74 +++++++++++++++++-- src/torcontrol/TorControl.h | 2 +- src/vidalia/MainWindow.cpp | 12 ++- src/vidalia/MainWindow.h | 2 +- .../plugin/extensions/qtscript_TorControl.cpp | 2 +- 6 files changed, 80 insertions(+), 15 deletions(-) diff --git a/changes/bug5855 b/changes/bug5855 new file mode 100644 index 0000000..610aae8 --- /dev/null +++ b/changes/bug5855 @@ -0,0 +1,3 @@ + New features: + o Use SafeCookie authentication method if available instead of the regular + cookie authentication. Resolves ticket 5855. diff --git a/src/torcontrol/TorControl.cpp b/src/torcontrol/TorControl.cpp index 01bfb1d..c7bf85d 100644 --- a/src/torcontrol/TorControl.cpp +++ b/src/torcontrol/TorControl.cpp @@ -19,10 +19,18 @@ #include "RouterStatus.h" #include "file.h" #include "stringutil.h" +#include "crypto.h" #include <QHostAddress> #include <QVariantMap> +#define SAFECOOKIE_SERVER_TO_CONTROLLER_CONSTANT \ + "Tor safe cookie authentication server-to-controller hash" +#define SAFECOOKIE_CONTROLLER_TO_SERVER_CONSTANT \ + "Tor safe cookie authentication controller-to-server hash" +#define AUTHENTICATION_COOKIE_LEN 32 +#define DIGEST256_LEN 32 +#define SAFECOOKIE_SERVER_NONCE_LEN DIGEST256_LEN /** Default constructor */ TorControl::TorControl(ControlMethod::Method method) @@ -333,7 +341,8 @@ TorControl::isConnected() bool TorControl::send(ControlCommand cmd, ControlReply &reply, QString *errmsg) { - if (!_authenticated and (cmd.keyword() != "AUTHENTICATE") and + if (!_authenticated and (cmd.keyword() != "AUTHCHALLENGE") and + (cmd.keyword() != "AUTHENTICATE") and (cmd.keyword() != "PROTOCOLINFO") and (cmd.keyword() != "QUIT")) { if (errmsg) @@ -366,18 +375,67 @@ TorControl::send(ControlCommand cmd, QString *errmsg) * "AUTHENTICATE" SP 1*HEXDIG CRLF */ bool -TorControl::authenticate(const QByteArray cookie, QString *errmsg) +TorControl::authenticate(const QByteArray cookie, bool safe, QString *errmsg) { - ControlCommand cmd("AUTHENTICATE", base16_encode(cookie)); ControlReply reply; QString str; + if (safe) { + QByteArray client_nonce = crypto_rand_bytes(DIGEST256_LEN); + ControlCommand cmdChallenge("AUTHCHALLENGE", QString("SAFECOOKIE %1").arg(base16_encode(client_nonce))); - if (!send(cmd, reply, &str)) { - emit authenticationFailed(str); - _shouldContinue = false; - _reason = str; + if (!send(cmdChallenge, reply, &str)) { + emit authenticationFailed(str); + _shouldContinue = false; + _reason = str; - return err(errmsg, str); + return err(errmsg, str); + } + + QHash<QString, QString> response = string_parse_keyvals(reply.getMessage()); + QString tmp; + tmp.append(cookie); + tmp.append(client_nonce); + tmp.append(base16_decode(response.value("SERVERNONCE").toAscii())); + + char *client_hash = (char*)malloc(DIGEST256_LEN); + char *server_hash = (char*)malloc(DIGEST256_LEN); + + crypto_hmac_sha256(server_hash, + SAFECOOKIE_SERVER_TO_CONTROLLER_CONSTANT, + strlen(SAFECOOKIE_SERVER_TO_CONTROLLER_CONSTANT), + tmp.toAscii().data(), + tmp.size()); + + if (!QString(server_hash).compare(response.value("SERVERHASH"))) { + str = "Server hash was wrong in SAFECOOKIE auth"; + return err(errmsg, str); + } + + crypto_hmac_sha256(client_hash, + SAFECOOKIE_CONTROLLER_TO_SERVER_CONSTANT, + strlen(SAFECOOKIE_CONTROLLER_TO_SERVER_CONSTANT), + tmp.toAscii().data(), + tmp.size()); + + ControlCommand cmd("AUTHENTICATE", base16_encode(QByteArray(client_hash, DIGEST256_LEN))); + + if (!send(cmd, reply, &str)) { + emit authenticationFailed(str); + _shouldContinue = false; + _reason = str; + + return err(errmsg, str); + } + } else { + ControlCommand cmd("AUTHENTICATE", base16_encode(cookie)); + + if (!send(cmd, reply, &str)) { + emit authenticationFailed(str); + _shouldContinue = false; + _reason = str; + + return err(errmsg, str); + } } onAuthenticated(); return true; diff --git a/src/torcontrol/TorControl.h b/src/torcontrol/TorControl.h index 3aa78d3..1158bbd 100644 --- a/src/torcontrol/TorControl.h +++ b/src/torcontrol/TorControl.h @@ -78,7 +78,7 @@ public: /** Check if we're connected to Tor's control socket */ bool isConnected(); /** Sends an authentication cookie to Tor. */ - bool authenticate(const QByteArray cookie, QString *errmsg = 0); + bool authenticate(const QByteArray cookie, bool safe = true, QString *errmsg = 0); /** Sends an authentication password to Tor. */ bool authenticate(const QString &password = QString(), QString *errmsg = 0); /** Returns true if the process has passed through auth successfully */ diff --git a/src/vidalia/MainWindow.cpp b/src/vidalia/MainWindow.cpp index 2ea816e..e3cacb0 100644 --- a/src/vidalia/MainWindow.cpp +++ b/src/vidalia/MainWindow.cpp @@ -1522,7 +1522,7 @@ MainWindow::authenticate() QString errmsg; if (authMethod == TorSettings::CookieAuth) { - if(tryCookie(pi)) { + if(tryCookie(pi, authMethods.contains("SAFECOOKIE"))) { authenticated(); return; } else { @@ -1556,7 +1556,7 @@ MainWindow::authenticate() } bool -MainWindow::tryCookie(const ProtocolInfo &pi) +MainWindow::tryCookie(const ProtocolInfo &pi, bool safe) { TorSettings settings; /* Try to load an auth cookie and send it to Tor */ @@ -1589,8 +1589,12 @@ MainWindow::tryCookie(const ProtocolInfo &pi) .arg(cookie.size())); return false; } - vNotice("Authenticating using 'cookie' authentication."); - return _torControl->authenticate(cookie); + if (safe) { + vNotice("Authenticating using 'safecookie' authentication."); + } else { + vNotice("Authenticating using 'cookie' authentication."); + } + return _torControl->authenticate(cookie, safe); } bool diff --git a/src/vidalia/MainWindow.h b/src/vidalia/MainWindow.h index 4bb3ef8..e5befa3 100644 --- a/src/vidalia/MainWindow.h +++ b/src/vidalia/MainWindow.h @@ -95,7 +95,7 @@ private slots: /** Called when Vidalia has successfully authenticated to Tor. */ void authenticated(); /** Called when authenticated() detects that you can do auth with a cookie */ - bool tryCookie(const ProtocolInfo &pi); + bool tryCookie(const ProtocolInfo &pi, bool safe = false); /** Called when cookie auth fails or when it's the only method configured */ bool tryHashed(); /** Called when Vidalia fails to authenticate to Tor. The failure reason is diff --git a/src/vidalia/plugin/extensions/qtscript_TorControl.cpp b/src/vidalia/plugin/extensions/qtscript_TorControl.cpp index 97cb237..67a3a7a 100644 --- a/src/vidalia/plugin/extensions/qtscript_TorControl.cpp +++ b/src/vidalia/plugin/extensions/qtscript_TorControl.cpp @@ -221,7 +221,7 @@ static QScriptValue qtscript_TorControl_prototype_call(QScriptContext *context, && qscriptvalue_cast<QString*>(context->argument(1))) { QByteArray _q_arg0 = qscriptvalue_cast<QByteArray>(context->argument(0)); QString* _q_arg1 = qscriptvalue_cast<QString*>(context->argument(1)); - bool _q_result = _q_self->authenticate(_q_arg0, _q_arg1); + bool _q_result = _q_self->authenticate(_q_arg0, false, _q_arg1); return QScriptValue(context->engine(), _q_result); } else if (context->argument(0).isString() && qscriptvalue_cast<QString*>(context->argument(1))) {

1 0

[vidalia/alpha] Add hmac_sha256 implementation based on tor's implementation
by chiiph＠torproject.org 04 Jul '12

04 Jul '12

commit 814eba4586ee932e896c6de230592882c49b0f9c Author: Tomás Touceda <chiiph(a)torproject.org> Date: Wed Jul 4 21:09:09 2012 -0300 Add hmac_sha256 implementation based on tor's implementation --- src/common/crypto.cpp | 87 +++++++++++++ src/common/crypto.h | 7 + src/common/sha256.c | 331 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 425 insertions(+), 0 deletions(-) diff --git a/src/common/crypto.cpp b/src/common/crypto.cpp index 223d202..5ae5295 100644 --- a/src/common/crypto.cpp +++ b/src/common/crypto.cpp @@ -187,3 +187,90 @@ crypto_secret_to_key(const QString &secret, const QByteArray &salt, quint8 c) return hash.result(); } +/** + * Read a 32-bit value beginning at cp. Equivalent to + * *(uint32_t*)(cp), but will not cause segfaults on platforms that forbid + * unaligned memory access. + */ +uint32_t +get_uint32(const void *cp) +{ + uint32_t v; + memcpy(&v,cp,4); + return v; +} +/** + * Set a 32-bit value beginning at cp to v. Equivalent to + * *(uint32_t*)(cp) = v, but will not cause segfaults on platforms that forbid + * unaligned memory access. */ +void +set_uint32(void *cp, uint32_t v) +{ + memcpy(cp,&v,4); +} + +#define STMT_BEGIN do { +#define STMT_END } while(0) +#define SHA256_CTX sha256_state +#define SHA256_Init sha256_init +#define SHA256_Update sha256_process +#define LTC_ARGCHK(x) Q_ASSERT(x) +#include "sha256.c" +#define SHA256_Final(a,b) sha256_done(b,a) + +static unsigned char * +SHA256(const unsigned char *m, size_t len, unsigned char *d) +{ + SHA256_CTX ctx; + SHA256_Init(&ctx); + SHA256_Update(&ctx, m, len); + SHA256_Final(d, &ctx); + return d; +} + +/** Compute the HMAC-SHA-256 of the msg_len bytes in msg, using + * the key of length key_len. Store the DIGEST256_LEN-byte + * result in hmac_out. + */ +void +crypto_hmac_sha256(char *hmac_out, + const char *key, size_t key_len, + const char *msg, size_t msg_len) +{ +#define BLOCKSIZE 64 +#define DIGESTSIZE 32 + uint8_t k[BLOCKSIZE]; + uint8_t pad[BLOCKSIZE]; + uint8_t d[DIGESTSIZE]; + int i; + SHA256_CTX st; + + if (key_len <= BLOCKSIZE) { + memset(k, 0, sizeof(k)); + memcpy(k, key, key_len); /* not time invariant in key_len */ + } else { + SHA256((const uint8_t *)key, key_len, k); + memset(k+DIGESTSIZE, 0, sizeof(k)-DIGESTSIZE); + } + for (i = 0; i < BLOCKSIZE; ++i) + pad[i] = k[i] ^ 0x36; + SHA256_Init(&st); + SHA256_Update(&st, pad, BLOCKSIZE); + SHA256_Update(&st, (uint8_t*)msg, msg_len); + SHA256_Final(d, &st); + + for (i = 0; i < BLOCKSIZE; ++i) + pad[i] = k[i] ^ 0x5c; + SHA256_Init(&st); + SHA256_Update(&st, pad, BLOCKSIZE); + SHA256_Update(&st, d, DIGESTSIZE); + SHA256_Final((uint8_t*)hmac_out, &st); + + /* Now clear everything. */ + memset(k, 0, sizeof(k)); + memset(pad, 0, sizeof(pad)); + memset(d, 0, sizeof(d)); + memset(&st, 0, sizeof(st)); +#undef BLOCKSIZE +#undef DIGESTSIZE +} diff --git a/src/common/crypto.h b/src/common/crypto.h index 65582ed..cbfde62 100644 --- a/src/common/crypto.h +++ b/src/common/crypto.h @@ -73,6 +73,13 @@ QString crypto_rand_string(int len); * return a default-constructed QByteArray. */ QByteArray crypto_secret_to_key(const QString &secret, const QByteArray &salt, quint8 c); +/** Compute the HMAC-SHA-256 of the msg_len bytes in msg, using + * the key of length key_len. Store the DIGEST256_LEN-byte + * result in hmac_out. + */ +void +crypto_hmac_sha256(char *hmac_out, const char *key, size_t key_len, + const char *msg, size_t msg_len); #endif diff --git a/src/common/sha256.c b/src/common/sha256.c new file mode 100644 index 0000000..813c68d --- /dev/null +++ b/src/common/sha256.c @@ -0,0 +1,331 @@ +/* Copyright (c) 2009-2012, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ +/* This SHA256 implementation is adapted from the public domain one in + LibTomCrypt, version 1.6. Tor uses it on platforms where OpenSSL doesn't + have a SHA256. */ + + +typedef struct sha256_state { + uint64_t length; + uint32_t state[8], curlen; + unsigned char buf[64]; +} sha256_state; + +#define CRYPT_OK 0 +#define CRYPT_NOP -1 +#define CRYPT_INVALID_ARG -2 + +#define LOAD32H(x,y) STMT_BEGIN x = ntohl(get_uint32((const char*)y)); STMT_END +#define STORE32H(x,y) STMT_BEGIN set_uint32((char*)y, htonl(x)); STMT_END +#define STORE64H(x,y) STMT_BEGIN \ + set_uint32((char*)y, htonl((uint32_t)((x)>>32))); \ + set_uint32(((char*)y)+4, htonl((uint32_t)((x)&0xffffffff))); \ + STMT_END +#define RORc(x, y) ( ((((unsigned long)(x)&0xFFFFFFFFUL)>>(unsigned long)((y)&31)) | ((unsigned long)(x)<<(unsigned long)(32-((y)&31)))) & 0xFFFFFFFFUL) +#ifndef MIN + #define MIN(x, y) ( ((x)<(y))?(x):(y) ) +#endif + + +/* LibTomCrypt, modular cryptographic library -- Tom St Denis + * + * LibTomCrypt is a library that provides various cryptographic + * algorithms in a highly modular and flexible manner. + * + * The library is free for all purposes without any express + * guarantee it works. + * + * Tom St Denis, tomstdenis(a)gmail.com, http://libtomcrypt.com + */ + +/** + @file sha256.c + SHA256 by Tom St Denis +*/ + + +#ifdef LTC_SMALL_CODE +/* the K array */ +static const uint32_t K[64] = { + 0x428a2f98UL, 0x71374491UL, 0xb5c0fbcfUL, 0xe9b5dba5UL, 0x3956c25bUL, + 0x59f111f1UL, 0x923f82a4UL, 0xab1c5ed5UL, 0xd807aa98UL, 0x12835b01UL, + 0x243185beUL, 0x550c7dc3UL, 0x72be5d74UL, 0x80deb1feUL, 0x9bdc06a7UL, + 0xc19bf174UL, 0xe49b69c1UL, 0xefbe4786UL, 0x0fc19dc6UL, 0x240ca1ccUL, + 0x2de92c6fUL, 0x4a7484aaUL, 0x5cb0a9dcUL, 0x76f988daUL, 0x983e5152UL, + 0xa831c66dUL, 0xb00327c8UL, 0xbf597fc7UL, 0xc6e00bf3UL, 0xd5a79147UL, + 0x06ca6351UL, 0x14292967UL, 0x27b70a85UL, 0x2e1b2138UL, 0x4d2c6dfcUL, + 0x53380d13UL, 0x650a7354UL, 0x766a0abbUL, 0x81c2c92eUL, 0x92722c85UL, + 0xa2bfe8a1UL, 0xa81a664bUL, 0xc24b8b70UL, 0xc76c51a3UL, 0xd192e819UL, + 0xd6990624UL, 0xf40e3585UL, 0x106aa070UL, 0x19a4c116UL, 0x1e376c08UL, + 0x2748774cUL, 0x34b0bcb5UL, 0x391c0cb3UL, 0x4ed8aa4aUL, 0x5b9cca4fUL, + 0x682e6ff3UL, 0x748f82eeUL, 0x78a5636fUL, 0x84c87814UL, 0x8cc70208UL, + 0x90befffaUL, 0xa4506cebUL, 0xbef9a3f7UL, 0xc67178f2UL +}; +#endif + +/* Various logical functions */ +#define Ch(x,y,z) (z ^ (x & (y ^ z))) +#define Maj(x,y,z) (((x | y) & z) | (x & y)) +#define S(x, n) RORc((x),(n)) +#define R(x, n) (((x)&0xFFFFFFFFUL)>>(n)) +#define Sigma0(x) (S(x, 2) ^ S(x, 13) ^ S(x, 22)) +#define Sigma1(x) (S(x, 6) ^ S(x, 11) ^ S(x, 25)) +#define Gamma0(x) (S(x, 7) ^ S(x, 18) ^ R(x, 3)) +#define Gamma1(x) (S(x, 17) ^ S(x, 19) ^ R(x, 10)) + +/* compress 512-bits */ +#ifdef LTC_CLEAN_STACK +static int _sha256_compress(sha256_state * md, unsigned char *buf) +#else +static int sha256_compress(sha256_state * md, unsigned char *buf) +#endif +{ + uint32_t S[8], W[64], t0, t1; +#ifdef LTC_SMALL_CODE + uint32_t t; +#endif + int i; + + /* copy state into S */ + for (i = 0; i < 8; i++) { + S[i] = md->state[i]; + } + + /* copy the state into 512-bits into W[0..15] */ + for (i = 0; i < 16; i++) { + LOAD32H(W[i], buf + (4*i)); + } + + /* fill W[16..63] */ + for (i = 16; i < 64; i++) { + W[i] = Gamma1(W[i - 2]) + W[i - 7] + Gamma0(W[i - 15]) + W[i - 16]; + } + + /* Compress */ +#ifdef LTC_SMALL_CODE +#define RND(a,b,c,d,e,f,g,h,i) \ + t0 = h + Sigma1(e) + Ch(e, f, g) + K[i] + W[i]; \ + t1 = Sigma0(a) + Maj(a, b, c); \ + d += t0; \ + h = t0 + t1; + + for (i = 0; i < 64; ++i) { + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],i); + t = S[7]; S[7] = S[6]; S[6] = S[5]; S[5] = S[4]; + S[4] = S[3]; S[3] = S[2]; S[2] = S[1]; S[1] = S[0]; S[0] = t; + } +#else +#define RND(a,b,c,d,e,f,g,h,i,ki) \ + t0 = h + Sigma1(e) + Ch(e, f, g) + ki + W[i]; \ + t1 = Sigma0(a) + Maj(a, b, c); \ + d += t0; \ + h = t0 + t1; + + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],0,0x428a2f98); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],1,0x71374491); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],2,0xb5c0fbcf); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],3,0xe9b5dba5); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],4,0x3956c25b); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],5,0x59f111f1); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],6,0x923f82a4); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],7,0xab1c5ed5); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],8,0xd807aa98); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],9,0x12835b01); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],10,0x243185be); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],11,0x550c7dc3); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],12,0x72be5d74); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],13,0x80deb1fe); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],14,0x9bdc06a7); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],15,0xc19bf174); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],16,0xe49b69c1); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],17,0xefbe4786); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],18,0x0fc19dc6); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],19,0x240ca1cc); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],20,0x2de92c6f); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],21,0x4a7484aa); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],22,0x5cb0a9dc); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],23,0x76f988da); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],24,0x983e5152); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],25,0xa831c66d); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],26,0xb00327c8); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],27,0xbf597fc7); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],28,0xc6e00bf3); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],29,0xd5a79147); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],30,0x06ca6351); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],31,0x14292967); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],32,0x27b70a85); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],33,0x2e1b2138); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],34,0x4d2c6dfc); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],35,0x53380d13); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],36,0x650a7354); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],37,0x766a0abb); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],38,0x81c2c92e); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],39,0x92722c85); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],40,0xa2bfe8a1); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],41,0xa81a664b); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],42,0xc24b8b70); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],43,0xc76c51a3); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],44,0xd192e819); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],45,0xd6990624); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],46,0xf40e3585); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],47,0x106aa070); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],48,0x19a4c116); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],49,0x1e376c08); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],50,0x2748774c); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],51,0x34b0bcb5); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],52,0x391c0cb3); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],53,0x4ed8aa4a); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],54,0x5b9cca4f); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],55,0x682e6ff3); + RND(S[0],S[1],S[2],S[3],S[4],S[5],S[6],S[7],56,0x748f82ee); + RND(S[7],S[0],S[1],S[2],S[3],S[4],S[5],S[6],57,0x78a5636f); + RND(S[6],S[7],S[0],S[1],S[2],S[3],S[4],S[5],58,0x84c87814); + RND(S[5],S[6],S[7],S[0],S[1],S[2],S[3],S[4],59,0x8cc70208); + RND(S[4],S[5],S[6],S[7],S[0],S[1],S[2],S[3],60,0x90befffa); + RND(S[3],S[4],S[5],S[6],S[7],S[0],S[1],S[2],61,0xa4506ceb); + RND(S[2],S[3],S[4],S[5],S[6],S[7],S[0],S[1],62,0xbef9a3f7); + RND(S[1],S[2],S[3],S[4],S[5],S[6],S[7],S[0],63,0xc67178f2); + +#undef RND + +#endif + + /* feedback */ + for (i = 0; i < 8; i++) { + md->state[i] = md->state[i] + S[i]; + } + return CRYPT_OK; +} + +#ifdef LTC_CLEAN_STACK +static int sha256_compress(sha256_state * md, unsigned char *buf) +{ + int err; + err = _sha256_compress(md, buf); + burn_stack(sizeof(uint32_t) * 74); + return err; +} +#endif + +/** + Initialize the hash state + @param md The hash state you wish to initialize + @return CRYPT_OK if successful +*/ +static int sha256_init(sha256_state * md) +{ + LTC_ARGCHK(md != NULL); + + md->curlen = 0; + md->length = 0; + md->state[0] = 0x6A09E667UL; + md->state[1] = 0xBB67AE85UL; + md->state[2] = 0x3C6EF372UL; + md->state[3] = 0xA54FF53AUL; + md->state[4] = 0x510E527FUL; + md->state[5] = 0x9B05688CUL; + md->state[6] = 0x1F83D9ABUL; + md->state[7] = 0x5BE0CD19UL; + return CRYPT_OK; +} + +/** + Process a block of memory though the hash + @param md The hash state + @param in The data to hash + @param inlen The length of the data (octets) + @return CRYPT_OK if successful +*/ +static int sha256_process (sha256_state * md, const unsigned char *in, unsigned long inlen) +{ + unsigned long n; + int err; + LTC_ARGCHK(md != NULL); + LTC_ARGCHK(in != NULL); + if (md->curlen > sizeof(md->buf)) { + return CRYPT_INVALID_ARG; + } + while (inlen > 0) { + if (md->curlen == 0 && inlen >= 64) { + if ((err = sha256_compress (md, (unsigned char *)in)) != CRYPT_OK) { + return err; + } + md->length += 64 * 8; + in += 64; + inlen -= 64; + } else { + n = MIN(inlen, (64 - md->curlen)); + memcpy(md->buf + md->curlen, in, (size_t)n); + md->curlen += n; + in += n; + inlen -= n; + if (md->curlen == 64) { + if ((err = sha256_compress (md, md->buf)) != CRYPT_OK) { + return err; + } + md->length += 8*64; + md->curlen = 0; + } + } + } + return CRYPT_OK; +} + +/** + Terminate the hash to get the digest + @param md The hash state + @param out [out] The destination of the hash (32 bytes) + @return CRYPT_OK if successful +*/ +static int sha256_done(sha256_state * md, unsigned char *out) +{ + int i; + + LTC_ARGCHK(md != NULL); + LTC_ARGCHK(out != NULL); + + if (md->curlen >= sizeof(md->buf)) { + return CRYPT_INVALID_ARG; + } + + + /* increase the length of the message */ + md->length += md->curlen * 8; + + /* append the '1' bit */ + md->buf[md->curlen++] = (unsigned char)0x80; + + /* if the length is currently above 56 bytes we append zeros + * then compress. Then we can fall back to padding zeros and length + * encoding like normal. + */ + if (md->curlen > 56) { + while (md->curlen < 64) { + md->buf[md->curlen++] = (unsigned char)0; + } + sha256_compress(md, md->buf); + md->curlen = 0; + } + + /* pad upto 56 bytes of zeroes */ + while (md->curlen < 56) { + md->buf[md->curlen++] = (unsigned char)0; + } + + /* store length */ + STORE64H(md->length, md->buf+56); + sha256_compress(md, md->buf); + + /* copy output */ + for (i = 0; i < 8; i++) { + STORE32H(md->state[i], out+(4*i)); + } +#ifdef LTC_CLEAN_STACK + zeromem(md, sizeof(sha256_state)); +#endif + return CRYPT_OK; +} + +/* $Source: /cvs/libtom/libtomcrypt/src/hashes/sha2/sha256.c,v $ */ +/* $Revision: 1.9 $ */ +/* $Date: 2006/11/01 09:28:17 $ */

1 0

[stem/master] Add unit tests for GETCONF parsing
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit f908ce9c44ffad9237d0f571351adb2143001f52 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Fri Jun 8 17:50:06 2012 +0530 Add unit tests for GETCONF parsing --- test/unit/response/__init__.py | 2 +- test/unit/response/getconf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/test/unit/response/__init__.py b/test/unit/response/__init__.py index 0e4889c..069ecba 100644 --- a/test/unit/response/__init__.py +++ b/test/unit/response/__init__.py @@ -2,5 +2,5 @@ Unit tests for stem.response. """ -__all__ = ["control_message", "control_line", "getinfo", "protocolinfo", "authchallenge"] +__all__ = ["control_message", "control_line", "getinfo", "getconf", "protocolinfo", "authchallenge"] diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py index b82256b..ca75130 100644 --- a/test/unit/response/getconf.py +++ b/test/unit/response/getconf.py @@ -6,7 +6,7 @@ import unittest import stem.socket import stem.response -import stem.response.getinfo +import stem.response.getconf import test.mocking as mocking EMPTY_RESPONSE = "250 OK"

1 0

[stem/master] Add GetConfResponse class for parsing GETCONF responses
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 5701329478dfc363da17d80cafca26f07a9a9def Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Fri Jun 8 12:41:09 2012 +0530 Add GetConfResponse class for parsing GETCONF responses --- run_tests.py | 2 + stem/response/__init__.py | 12 +++++- stem/response/getconf.py | 53 +++++++++++++++++++++++++ test/unit/response/getconf.py | 87 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 153 insertions(+), 1 deletions(-) diff --git a/run_tests.py b/run_tests.py index 7ccedd3..ea12531 100755 --- a/run_tests.py +++ b/run_tests.py @@ -22,6 +22,7 @@ import test.unit.descriptor.extrainfo_descriptor import test.unit.response.control_line import test.unit.response.control_message import test.unit.response.getinfo +import test.unit.response.getconf import test.unit.response.protocolinfo import test.unit.response.authchallenge import test.unit.util.conf @@ -110,6 +111,7 @@ UNIT_TESTS = ( test.unit.response.control_message.TestControlMessage, test.unit.response.control_line.TestControlLine, test.unit.response.getinfo.TestGetInfoResponse, + test.unit.response.getconf.TestGetConfResponse, test.unit.response.protocolinfo.TestProtocolInfoResponse, test.unit.response.authchallenge.TestAuthChallengeResponse, test.unit.connection.authentication.TestAuthenticate, diff --git a/stem/response/__init__.py b/stem/response/__init__.py index dfae1d3..ae3af4c 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -25,7 +25,7 @@ Parses replies from the control socket. from __future__ import with_statement -__all__ = ["getinfo", "protocolinfo", "authchallenge", "convert", "ControlMessage", "ControlLine"] +__all__ = ["getinfo", "getconf", "protocolinfo", "authchallenge", "convert", "ControlMessage", "ControlLine"] import re import threading @@ -49,6 +49,7 @@ def convert(response_type, message): subclass for its response type. Recognized types include... * GETINFO + * GETCONF * PROTOCOLINFO * AUTHCHALLENGE @@ -59,10 +60,12 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type + * :class:`stem.response.InvalidRequest` the request was invalid * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ import stem.response.getinfo + import stem.response.getconf import stem.response.protocolinfo import stem.response.authchallenge @@ -71,6 +74,8 @@ def convert(response_type, message): if response_type == "GETINFO": response_class = stem.response.getinfo.GetInfoResponse + elif response_type == "GETCONF": + response_class = stem.response.getconf.GetConfResponse elif response_type == "PROTOCOLINFO": response_class = stem.response.protocolinfo.ProtocolInfoResponse elif response_type == "AUTHCHALLENGE": @@ -408,3 +413,8 @@ def _get_quote_indeces(line, escaped): return tuple(indices) +class InvalidRequest(Exception): + """ + Base Exception class for invalid requests + """ + pass diff --git a/stem/response/getconf.py b/stem/response/getconf.py new file mode 100644 index 0000000..8dcd483 --- /dev/null +++ b/stem/response/getconf.py @@ -0,0 +1,53 @@ +import re + +import stem.socket +import stem.response + +class GetConfResponse(stem.response.ControlMessage): + """ + Reply for a GETCONF query. + + :var dict entries: mapping between the queried options and their values + """ + + def _parse_message(self): + # Example: + # 250-CookieAuthentication=0 + # 250-ControlPort=9100 + # 250-DataDirectory=/home/neena/.tor + # 250 DirPort + + self.entries = {} + remaining_lines = list(self) + + if self.content() == [("250", " ", "OK")]: return + + if not self.is_ok(): + unrecognized_keywords = [] + for code, _, line in self.content(): + if code == '552': + try: + # to parse: 552 Unrecognized configuration key "zinc" + unrecognized_keywords.append(re.search('"([^"]+)"', line).groups()[0]) + except: + pass + + if unrecognized_keywords: + raise stem.response.InvalidRequest("GETCONF request contained unrecognized keywords: %s\n" \ + % ', '.join(unrecognized_keywords)) + else: + raise stem.socket.ProtocolError("GETCONF response contained a non-OK status code:\n%s" % self) + + while remaining_lines: + line = remaining_lines.pop(0) + + if '=' in line: + if line[line.find("=") + 1] == "\"": + key, value = line.pop_mapping(True) + else: + key, value = line.split("=", 1) + else: + key, value = (line, None) + + self.entries[key] = value + diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py new file mode 100644 index 0000000..b82256b --- /dev/null +++ b/test/unit/response/getconf.py @@ -0,0 +1,87 @@ +""" +Unit tests for the stem.response.getconf.GetConfResponse class. +""" + +import unittest + +import stem.socket +import stem.response +import stem.response.getinfo +import test.mocking as mocking + +EMPTY_RESPONSE = "250 OK" + +SINGLE_RESPONSE = """\ +250 DataDirectory=/home/neena/.tor""" + +BATCH_RESPONSE = """\ +250-CookieAuthentication=0 +250-ControlPort=9100 +250-DataDirectory=/tmp/fake dir +250 DirPort""" + +UNRECOGNIZED_KEY_RESPONSE = "552 Unrecognized configuration key \"yellowbrickroad\"" + +INVALID_RESPONSE = """\ +123-FOO +232 BAR""" + +class TestGetConfResponse(unittest.TestCase): + def test_empty_response(self): + """ + Parses a GETCONF reply without options (just calling "GETCONF"). + """ + + control_message = mocking.get_message(EMPTY_RESPONSE) + stem.response.convert("GETCONF", control_message) + + # now this should be a GetConfResponse (ControlMessage subclass) + self.assertTrue(isinstance(control_message, stem.response.ControlMessage)) + self.assertTrue(isinstance(control_message, stem.response.getconf.GetConfResponse)) + + self.assertEqual({}, control_message.entries) + + def test_single_response(self): + """ + Parses a GETCONF reply response for a single parameter. + """ + + control_message = mocking.get_message(SINGLE_RESPONSE) + stem.response.convert("GETCONF", control_message) + self.assertEqual({"DataDirectory": "/home/neena/.tor"}, control_message.entries) + + def test_batch_response(self): + """ + Parses a GETCONF reply for muiltiple parameters. + """ + + control_message = mocking.get_message(BATCH_RESPONSE) + stem.response.convert("GETCONF", control_message) + + expected = { + "CookieAuthentication": "0", + "ControlPort": "9100", + "DataDirectory": "/tmp/fake dir", + "DirPort": None, + } + + self.assertEqual(expected, control_message.entries) + + def test_unrecognized_key_response(self): + """ + Parses a GETCONF reply that contains an error code with an unrecognized key. + """ + + control_message = mocking.get_message(UNRECOGNIZED_KEY_RESPONSE) + self.assertRaises(stem.response.InvalidRequest, stem.response.convert, "GETCONF", control_message) + + def test_invalid_multiline_content(self): + """ + Parses a malformed GETCONF reply that contains an invalid response code. + This is a proper controller message, but malformed according to the + GETCONF's spec. + """ + + control_message = mocking.get_message(INVALID_RESPONSE) + self.assertRaises(stem.socket.ProtocolError, stem.response.convert, "GETCONF", control_message) +

1 0

[stem/master] InvalidRequest now inherits from ControllerError
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 0db367a151dc75fde8a3a90fd273bda7ad9227ab Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Jun 9 09:49:07 2012 +0530 InvalidRequest now inherits from ControllerError Moved stem.response.InvalidRequest -> stem.socket.InvalidRequest and made it a subclass of stem.socket.ControllerError --- stem/response/__init__.py | 7 +------ stem/response/getconf.py | 2 +- stem/socket.py | 4 ++++ test/unit/response/getconf.py | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/stem/response/__init__.py b/stem/response/__init__.py index ae3af4c..a9b69a3 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -60,7 +60,7 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type - * :class:`stem.response.InvalidRequest` the request was invalid + * :class:`stem.socket.InvalidRequest` the request was invalid * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ @@ -413,8 +413,3 @@ def _get_quote_indeces(line, escaped): return tuple(indices) -class InvalidRequest(Exception): - """ - Base Exception class for invalid requests - """ - pass diff --git a/stem/response/getconf.py b/stem/response/getconf.py index 8dcd483..c1872cd 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -33,7 +33,7 @@ class GetConfResponse(stem.response.ControlMessage): pass if unrecognized_keywords: - raise stem.response.InvalidRequest("GETCONF request contained unrecognized keywords: %s\n" \ + raise stem.socket.InvalidRequest("GETCONF request contained unrecognized keywords: %s\n" \ % ', '.join(unrecognized_keywords)) else: raise stem.socket.ProtocolError("GETCONF response contained a non-OK status code:\n%s" % self) diff --git a/stem/socket.py b/stem/socket.py index 1a14c82..258a7dc 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -28,6 +28,7 @@ as instances of the :class:`stem.response.ControlMessage` class. ControllerError - Base exception raised when using the controller. |- ProtocolError - Malformed socket data. + |- InvalidRequest - Invalid request parameters. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. """ @@ -548,6 +549,9 @@ class ControllerError(Exception): class ProtocolError(ControllerError): "Malformed content from the control socket." +class InvalidRequest(ControllerError): + "Base Exception class for invalid requests" + class SocketError(ControllerError): "Error arose while communicating with the control socket." diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py index ca75130..5dd8964 100644 --- a/test/unit/response/getconf.py +++ b/test/unit/response/getconf.py @@ -73,7 +73,7 @@ class TestGetConfResponse(unittest.TestCase): """ control_message = mocking.get_message(UNRECOGNIZED_KEY_RESPONSE) - self.assertRaises(stem.response.InvalidRequest, stem.response.convert, "GETCONF", control_message) + self.assertRaises(stem.socket.InvalidRequest, stem.response.convert, "GETCONF", control_message) def test_invalid_multiline_content(self): """

1 0

[stem/master] Add integration tests for testing Controller.get_conf
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 16d392ac74996ae38a8f3a33191ebc1899a5cf8f Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Jun 9 09:56:17 2012 +0530 Add integration tests for testing Controller.get_conf --- test/integ/control/controller.py | 38 ++++++++++++++++++++++++++++++++++++++ 1 files changed, 38 insertions(+), 0 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 5c10b3d..479c75b 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -134,4 +134,42 @@ class TestController(unittest.TestCase): auth_methods.append(stem.response.protocolinfo.AuthMethod.NONE) self.assertEqual(tuple(auth_methods), protocolinfo.auth_methods) + + def test_getconf(self): + """ + Exercises GETCONF with valid and invalid queries. + """ + + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + # successful single query + + control_port = str(runner.get_tor_socket().get_port()) + torrc_path = runner.get_torrc_path() + self.assertEqual(control_port, controller.get_conf("ControlPort")) + self.assertEqual(control_port, controller.get_conf("ControlPort", "la-di-dah")) + + # succeessful batch query + + expected = {"ControlPort": control_port} + self.assertEqual(expected, controller.get_conf(["ControlPort"])) + self.assertEqual(expected, controller.get_conf(["ControlPort"], "la-di-dah")) + + getconf_params = set(["ControlPort", "DirPort", "DataDirectory"]) + self.assertEqual(getconf_params, set(controller.get_conf(["ControlPort", + "DirPort", "DataDirectory"]))) + + # non-existant option + + self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "blarg") + self.assertEqual("la-di-dah", controller.get_conf("blarg", "la-di-dah")) + + # empty input + + self.assertRaises(stem.socket.ControllerError, controller.get_conf, "") + self.assertEqual("la-di-dah", controller.get_conf("", "la-di-dah")) + + self.assertEqual({}, controller.get_conf([])) + self.assertEqual({}, controller.get_conf([], {}))

1 0

[stem/master] Add get_conf convenience method to Controller
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit f01a50e5bd1b24cb30676d869057fea3c8e04af9 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Jun 9 09:55:01 2012 +0530 Add get_conf convenience method to Controller --- stem/control.py | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 50 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index 9c5c515..c6bf29d 100644 --- a/stem/control.py +++ b/stem/control.py @@ -531,3 +531,53 @@ class Controller(BaseController): return stem.connection.get_protocolinfo(self) + def get_conf(self, param, default = None): + """ + Queries the control socket for the values of given configuration options. If + provided a default then that's returned as the if the GETCONF option is undefined + or if the call fails for any reason (invalid configuration option, error + response, control port closed, initiated, etc). + + :param str,list param: GETCONF option or options to be queried + :param object default: response if the query fails + + :returns: + Response depends upon how we were called as follows... + + * str with the response if our param was a str + * dict with the param => response mapping if our param was a list + * default if one was provided and our call failed + + :raises: + :class:`stem.socket.ControllerError` if the call fails, and we weren't provided a default response + :class:`stem.socket.InvalidRequest` if configuration option requested was invalid. + """ + + if isinstance(param, str): + is_multiple = False + param = [param] + else: + is_multiple = True + + try: + response = self.msg("GETCONF %s" % " ".join(param)) + stem.response.convert("GETCONF", response) + + # error if we got back different parameters than we requested + requested_params = set(param) + reply_params = set(response.entries.keys()) + + if requested_params != reply_params: + requested_label = ", ".join(requested_params) + reply_label = ", ".join(reply_params) + + raise stem.socket.ProtocolError("GETCONF reply doesn't match the parameters that we requested. Queried '%s' but got '%s'." % (requested_label, reply_label)) + + if is_multiple: + return response.entries + else: + return response.entries[param[0]] + except stem.socket.ControllerError, exc: + if default is None: raise exc + else: return default +

1 0

[stem/master] Minor change to GetConfResponse documentation
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit ece7f85dd675633de3b866c868bba1560fd22060 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Tue Jun 12 21:07:13 2012 +0530 Minor change to GetConfResponse documentation --- stem/control.py | 2 +- stem/response/__init__.py | 2 +- stem/response/getconf.py | 28 ++++++++++------------------ 3 files changed, 12 insertions(+), 20 deletions(-) diff --git a/stem/control.py b/stem/control.py index f0459cb..a616b5c 100644 --- a/stem/control.py +++ b/stem/control.py @@ -534,7 +534,7 @@ class Controller(BaseController): def get_conf(self, param, default = None): """ Queries the control socket for the values of given configuration options. If - provided a default then that's returned as the if the GETCONF option is undefined + provided a default then that's returned as if the GETCONF option is undefined or if the call fails for any reason (invalid configuration option, error response, control port closed, initiated, etc). diff --git a/stem/response/__init__.py b/stem/response/__init__.py index 43ecb3b..273bead 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -60,7 +60,7 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type - * :class:`stem.socket.InvalidArguments` the request's arguments are invalid + * :class:`stem.socket.InvalidArguments` Raised if the request's arguments when converting GETCONF or GETINFO responses are invalid * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ diff --git a/stem/response/getconf.py b/stem/response/getconf.py index cffbc61..41f1857 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -1,29 +1,21 @@ import stem.socket import stem.response -def _getval(dictionary, key): - try: - return dictionary[key] - except KeyError: - pass - def _split_line(line): - try: - if '=' in line: - if line[line.find("=") + 1] == "\"": - return line.pop_mapping(True) - else: - return line.split("=", 1) - else: - return (line, None) - except IndexError: - return (line[:-1], None) + if line.is_next_mapping(quoted = False): + return line.split("=", 1) # TODO: make this part of the ControlLine? + elif line.is_next_mapping(quoted = True): + return line.pop_mapping(True).items()[0] + else: + return (line.pop(), None) class GetConfResponse(stem.response.ControlMessage): """ Reply for a GETCONF query. - :var dict entries: mapping between the queried options and their values + :var dict entries: + mapping between the queried options (string) and their values (string/list + of strings) """ def _parse_message(self): @@ -54,7 +46,7 @@ class GetConfResponse(stem.response.ControlMessage): line = remaining_lines.pop(0) key, value = _split_line(line) - entry = _getval(self.entries, key) + entry = self.entries.get(key, None) if type(entry) == str and entry != value: self.entries[key] = [entry]

1 0