README 3.89 KB
Newer Older
putro's avatar
putro committed
1 2 3 4 5 6 7 8 9
THIS SOFWARE IS BETA

nymhelper is a script that helps in creating and using a nym 
nymhelper has been developed starting from nymgrind (http://www.banana.mixmin.net/svn/nymgrind/)

REQUIREMENTS:

gnupg (http://www.gnupg.org)
mixmaster  (http://mixmaster.sourceforge.net
10
python-gnupg ((https://bitbucket.org/vinay.sajip/python-gnupg)
putro's avatar
putro committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28


INSTALLATION:

simply copy the script in a directory
gnupg.py, random_binary_data and test_gnupg.py come from the python-gnupg module (http://code.google.com/p/python-gnupg)
you can keep this files locally in the same dir of the nymhelper.py script,
or you can install the python-gnupg on your system and delete these files from the script directory.


USAGE:

first, edit file config.ini and change settings where required.
There are different config section:
    "options" - miscellaneous config options
    "1" - first (and required) nym data
    "2" - second (optional) nym data
    you can add other sections for each nym you have
putro's avatar
putro committed
29 30
    for every nym follow the same syntax of section "1", pwd can be left empy 
		(unless you keep the config file encrypted you should NEVER write password here, and anyway writing password is always a bad idea).
putro's avatar
putro committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

to start simply type ./nymhelper.py and follow the on screen menu:


MENU:

    1 to choose/select active nym
        select the active nym (if you have more than one defined in config.ini)
    2 to write a message (as active nym)
        write a message and prepare it to be sent to send@nym-server-address
        the message is saved in file defined in config.py (message-out).
        You will be asked to choose a subject and the text
    3 to send the message created via local mixmaster
        send the message you prepared through a local mixmaster to send|config@nym-server-address
        You will be asked to choose a recipient (default should be fine), a subject (it's the subject
        of the encrypted message that the nym server will receive, not the subject of the message that
        will be received by the recipient), and a remailer chain (used to send the message to the nym server).
    4 to download fresh remailer stats
        download fresh stats from pinger defined in config.py
    5 to choose remailer chain, 
        this is optional, you will prompted for remailer chain if needed
    6 to create or update a nym
putro's avatar
putro committed
53 54
        create or update (i.e. with a new reply block) a nym 
        nym has to be already defined in config.ini and selected with menu choice "1")
putro's avatar
putro committed
55 56 57 58 59 60 61 62 63 64 65 66
        you will be asked for a remailer chain if not yet choosed, this will be the chain of the reply-block for your nym.
    7 to delete a nym
        to be implemented
    8 to create a new secret key
        to create a gnupg RSA key in your personal gnupg keyring  (to be improved)
    9 to delete a secret key from your personal keyring
    10 to send msg via smtp
        same as menu "3", but messages are sent through a local or remote SMTP server.   
        Useful just for test, messages are not anonymized.
    q to quit


putro's avatar
putro committed
67 68
you can specify a different config file (default config.ini)
nymhelper.py -C configfile
putro's avatar
putro committed
69

putro's avatar
putro committed
70
you can send a message from a nym directly via command line with this syntax:
putro's avatar
putro committed
71
nymhelper.py -n 2 -s "subject" -r recipient -t "text of the message" -c "remailer1,remailer2"
putro's avatar
putro committed
72 73
-n is the nym number in config file
-s "subject"
putro's avatar
putro committed
74
-r recipient
putro's avatar
putro committed
75
-t "text of the message"
putro's avatar
putro committed
76 77
-c remailer chain to be used to send the message (through your local mixmaster client)

putro's avatar
putro committed
78
for nyms rarely used, you can put this on crontab to keep the nym alive, 
putro's avatar
putro committed
79 80 81 82 83 84 85 86 87 88 89
or to quickly check if the nym is working well.

for help type:
nymhelper.py -h

    
NOTES:

nyms pointing to newsgroups as final destination will have the subject (defined in config.ini) 
encrypted in hsub format,
to recognize them you have to use a software like news2mail (http://www.is-not-my.name/news2mail/) 
90
or aam2mail (https://github.com/crooks/aam2mail)
putro's avatar
putro committed
91 92


93
be sure to have the right keys in your keyring
putro's avatar
putro committed
94 95


96
contacts: putro at autistici dot org