Home page

• https://launchpad.net/pygpgme

Use

PyGPGME is a Python module that lets you sign, verify, encrypt and decrypt messages using the OpenPGP format.

Installation

You need the GPGME library and header files installed to successfully install PyGPGME

pip install PyGPGME

Usage

The documentation for this package is almost non existent i hope my examples will be able to help at least with getting users started

Creating a key

This is similar to running the following command:

gpg --gen-key

import os
import gpgme

key_params = """
<GnupgKeyParms format="internal">
Key-Type: RSA
Key-Length: 2048
Name-Real: Jaja of Opobo
Name-Email: jaja@example.com
Expire-Date: 0
Passphrase: secret
</GnupgKeyParms>
"""

# create custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
if not os.path.exists(gpghome):
    os.mkdir(gpghome, 0700)

# set the environment to custom gpg directory
os.environ['GNUPGHOME'] = gpghome
# create a blank configuration file
with open(os.path.join(gpghome, 'gpg.conf'), 'wv') as handle:
    handle.write('')

# create a context
ctx = gpgme.Context()
# create the key using key_params
result = ctx.genkey(key_params)
# get the key
key = ctx.get_key(result.fpr, True)
[uid] = key.uids
# print key name and email
print uid.name, uid.email

Exporting a key

This is similar to running the following command:

gpg --export [UID]

import os
import gpgme
from io import BytesIO

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome

# create a context
ctx = gpgme.Context()
ctx.armor = True
keydata = BytesIO()
[key] = ctx.keylist()
ctx.export(key.subkeys[0].keyid, keydata)
print keydata.getvalue()

Importing a key

This is similar to running the following command:

gpg --import [Filename]

import os
import gpgme
import urllib2

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome

# create a context
ctx = gpgme.Context()
# Download a public key
handle = urllib2.urlopen('http://repo.baruwa.org/RPM-GPG-KEY-BARUWA')
# Import the key
_ = ctx.import_(handle)
# Get key and print out keyID
key = ctx.get_key('4BA17AC7')
print "Imported key ID: ", key.uids[0].uid

Delete a key

This is similar to running the following command:

gpg --delete-key UID

import os
import gpgme

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome

# create a context
ctx = gpgme.Context()
# Get the public key we just imported
key = ctx.get_key('4BA17AC7')
# Delete the key
ctx.delete(key)

Sign and verify text

This is similar to running the following commands:

gpg -s (or --sign) [Data]
gpg [--verify] [Data]

import os
import gpgme
from io import BytesIO

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome
# allow our passphrase callback to work
del os.environ['GPG_AGENT_INFO']

# passphrase callback function
def passphrase_cb(uid_hint, passphrase_info, prev_was_bad, fd):
    "pass phrase callback"
    os.write(fd, b'secret\\n')

# create a context
ctx = gpgme.Context()
ctx.armor = True
[key] = ctx.keylist()
ctx.signers = [key]
ctx.passphrase_cb = passphrase_cb

# sign the data
plaintext = BytesIO(b'Text to be signed\\n')
signature = BytesIO()
signed = ctx.sign(plaintext, signature, gpgme.SIG_MODE_DETACH)

# rewind files
_ = signature.seek(0)
_ = plaintext.seek(0)

# Verify signature
sigs = ctx.verify(signature, plaintext, None)
if sigs[0].fpr == key.subkeys[0].fpr:
    print "Signature verified"
    print sigs[0].fpr, key.subkeys[0].fpr
else:
    print "Signature verification failed"

Encrypt and Decrypt text

This is similar to running the following commands:

gpg -e Recipient [Data]
gpg [-d] [Data]

import os
import gpgme
from io import BytesIO

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome
# allow our passphrase callback to work
del os.environ['GPG_AGENT_INFO']

recipient_params = """
<GnupgKeyParms format="internal">
Key-Type: RSA
Key-Length: 2048
Name-Real: Nana of itsikiri
Name-Email: nana@example.com
Expire-Date: 0
Passphrase: secret
</GnupgKeyParms>
"""

# passphrase callback function
def passphrase_cb(uid_hint, passphrase_info, prev_was_bad, fd):
    "pass phrase callback"
    os.write(fd, b'secret\\n')

# create a context
ctx = gpgme.Context()
ctx.armor = True
# create a recipient's key
result = ctx.genkey(recipient_params)
recipient = ctx.get_key(result.fpr, True)

plaintext = BytesIO(b'Very Secret text\\n')
ciphertext = BytesIO()
ctx.encrypt([recipient], gpgme.ENCRYPT_ALWAYS_TRUST, plaintext, ciphertext)

# rewind files
_ = ciphertext.seek(0)
_ = plaintext = BytesIO()
ctx.passphrase_cb = passphrase_cb
ctx.decrypt(ciphertext, plaintext)
print "The decrypted text is: ", plaintext.getvalue()

List keys

This is similar to running the following command:

gpg --list-keys

import os
import gpgme

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome

# create a context
ctx = gpgme.Context()
# iterate key list
for key in ctx.keylist():
    for uid in key.uids:
        print uid.uid

List secret keys

This is similar to running the following command:

gpg --list-secret-keys

import os
import gpgme

# set the environment to custom gpg directory
gpghome = os.path.expanduser('~/gpghome')
os.environ['GNUPGHOME'] = gpghome

# create a context
ctx = gpgme.Context()
# iterate secret key list
for key in ctx.keylist(None, True):
    for uid in key.uids:
        print uid.uid

And there is more.

For more GPG operations you can perform look at the API

import gpgme
help(gpgme)

Home page

• http://hewgill.com/pydkim/

Use

The pydkim module is a Python module that implements DKIM (DomainKeys Identified Mail) email signing and verification.

DomainKeys Identified Mail (DKIM) lets an organization take responsibility for a message that is in transit. Technically DKIM provides a method for validating a domain name identity that is associated with a message through cryptographic authentication.

Although DKIM is implemented in most MTA's, in some cases you have a setup where you do not want to run and manage an SMTP server yourself say for example if your Python application uses Amazon SES to send out email. So you can use pydkim within your email generation code to sign your messages before passing them to SES.

Installation

pip install pydkim

Usage

The package provides a command line interface as well as a Python Class.

Python Class

Sign a message

from email.message import Message

from dkim import sign

body = """Hi There,

This is a simple message that will be signed by pydkim

--The signer
"""
# compose a simple message
msg = Message()
msg['From'] = 'Sender <sender@topdog-software.com>'
msg['To'] = 'Recipient <recipient@example.com>'
msg['Subject'] = 'Test message'
msg.set_payload(body)

# sign the message
private_key = open('default.pem').read()
headers = ['To', 'From', 'Subject']
email = msg.as_string()
sig = sign(email, 'default', 'topdog-software.com', private_key, include_headers=headers)
print sig, email

Output:

DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple;
 d=topdog-software.com; i=@topdog-software.com; q=dns/txt; s=default;
 t=1336488625; h=From : To : Subject;
 bh=skd2vA1wrCEzamCzKOvVKCaVhhpP1ihoQgGldgTSVUE=; b=vGQgSjJxkTZe+NZZl
lqszgxGshTcixlcfFos+XpLnAj1fnhA5SuBASoB4dVQUlVW76U5s9Dn1zSSsKH
6bCahl4oPqZaE5t6Ke5wpGwA+cBWZRrSuDDD/L8g9nYi04SVb+lMF9mJyQCeZj
pBtMomaOvGF8GNXsiKTFZR9RDv0wWw=
From: Sender <sender@topdog-software.com>
To: Recipient <recipient@example.com>
Subject: Test message

Hi There,

This is a simple message that will be signed by pydkim

--The signer

Verify a message (I use the same message signed above)

from dkim import verify

if verify(open('email.txt').read()):
    print "Email verified successfully"

True

Command line

Sign a message

dkimsign.py selector domain privatekeyfile [identity]

Verify a message

cat email.txt | dkimverify.py
echo $?

And there is more.

For details of the API please refer to the documentation. Happy DKIMing

Home page

• http://www.dnspython.org/

Use

dnspython is a DNS toolkit for Python. It supports almost all record types. It can be used for queries, zone transfers, and dynamic updates. It supports TSIG authenticated messages and EDNS0.

dnspython provides both high and low level access to DNS. The high level classes perform queries for data of a given name, type, and class, and return an answer set. The low level classes allow direct manipulation of DNS zones, messages, names, and records.

Installation

pip install dnspython

Usage

Lookup DNS records (A, AAAA, MX, NS)

A Records

import dns.resolver
answers = dns.resolver.query('topdog.za.net', 'A')
for rdata in answers:
    print rdata.address

AAAA Records

import dns.resolver
answers = dns.resolver.query('topdog.za.net', 'AAAA')
for rdata in answers:
    print rdata.address

MX Records

import dns.resolver
answers = dns.resolver.query('topdog.za.net', 'MX')
for rdata in answers:
    print 'host', rdata.exchange, 'has preference', rdata.preference

NS Records

import dns.resolver
answers = dns.resolver.query('topdog.za.net', 'NS')
for rdata in answers:
    print rdata.to_text()

Transfer a Zone from a server.

import dns.zone
import dns.query
zone = dns.zone.from_xfr(dns.query.xfr('174.136.108.83', 'topdog.za.net'))
print "*" * 10, "A records", "*" * 10
for (name, ttl, rdata) in zone.iterate_rdatas('A'):
    print name, "with TTL", ttl, "points to", rdata
print "*" * 10, "MX records", "*" * 10
for (name, ttl, rdata) in zone.iterate_rdatas('MX'):
    print name, "with TTL", ttl, "points to", rdata
print "*" * 10, "NS records", "*" * 10
for (name, ttl, rdata) in zone.iterate_rdatas('NS'):
    print name, "with TTL", ttl, "points to", rdata

Generate reverse names

import dns.reversename
print dns.reversename.from_address('174.136.108.83')

Perform a Dynamic record update (example from documentation modified)

import dns.query
import dns.tsigkeyring
import dns.update
import sys

if __name__ == '__main__':
    keyring = dns.tsigkeyring.from_text({
        'host-example.' : 'XXXXXXXXXXXXXXXXXXXXXX=='
    })
    # Replace an A record
    update = dns.update.Update('example.com', keyring=keyring)
    update.replace('host', 300, 'a', sys.argv[1])
    response = dns.query.tcp(update, '10.0.0.1')

And there is more

There is more that can be done using this package please refer to the documentation.

Home page

• https://github.com/haypo/python-ipy/

Use

The IP class allows a comfortable parsing and handling for most notations in use for IPv4 and IPv6 addresses and networks. It was greatly inspired by RIPE's Perl module NET::IP's interface but doesn't share the implementation.

Installation

pip install IPy

Usage

Print IP addresses in an IP range

from IPy import IP
network = IP('192.168.0.0/30')
for ip in network:
    print ip

Output:

192.168.0.0
192.168.0.1
192.168.0.2
192.168.0.3

Generate Reverse names for reverse lookup/PTR records

from IPy import IP
network = IP('192.168.0.0/30')
for ip in network:
    print ip.reverseName()

from IPy import IP
network = IP('192.168.0.0/30').reverseNames()
for ip in network:
    print ip

Output:

0.0.168.192.in-addr.arpa.
1.0.168.192.in-addr.arpa.
2.0.168.192.in-addr.arpa.
3.0.168.192.in-addr.arpa.

Check IP version:

from IPy import IP
print IP('192.168.0.0/30').version()
print IP('::1').version()

Output:

4
6

Get network prefixes

from IPy import IP
print IP('192.168.0.0/30')
print IP('192.168.0.0/255.255.255.252')
print IP('192.168.0.0-192.168.0.3)

Output:

192.168.0.0/30
192.168.0.0/30
192.168.0.0/30

Get the broadcast address

from IPy import IP
print IP('192.168.0.0/30').broadcast()

Output:

192.168.0.3

Get the network mask

from IPy import IP
print IP('192.168.0.0/30').netmask()

Output:

255.255.255.252

Check if an IP address is within a network

from IPy import IP
'192.168.0.1' in IP('192.168.0.0/30')

Check a network type LOOPBACK, PRIVATE, PUBLIC, RESERVED

from IPy import IP
print IP('192.168.0.1').iptype()

Output:

PRIVATE

And there is more

There is more that can be done using this package please refer to the documentation or run.

import IPy
help(IPy)

Home page

• http://xael.org/norman/python/pyclamd/

Use

pyClamd is a python interface to Clamd (Clamav daemon). By using pyClamd, you can add virus detection capabilities to your python software in an efficient and easy way.

pyClamd may be used by a closed source product, as it does not link with the GPL licensed libclamav.

Installation

This package is not available on the cheeseshop (PYPI) so you need to install it by downloading the module.

wget http://xael.org/norman/python/pyclamd/pyclamd.py
mv pyclamd.py $(python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")/

Usage

pyClamd supports connections to clamd using both TCP and UNIX sockets.

TCP

import pyclamd
pyclamd.init_network_socket('localhost', 3310)
print pyclamd.version()

Output:

ClamAV 0.97.4/14869/Tue May  1 22:38:26 2012

Unix socket

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
print pyclamd.version()

Output:

ClamAV 0.97.4/14869/Tue May  1 22:38:26 2012

Scan files

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
pyclamd.contscan_file('/tmp')

Scan and stop if virus detected

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
pyclamd.scan_file('/tmp')

Ping server to check if still alive

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
pyclamd.ping()

Scan a stream

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
mystring = 'X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*'
pyclamd.scan_stream(mystring)

Output:

{'stream': 'Eicar-Test-Signature'}

Reload clamd

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
pyclamd.reload()

Output:

'RELOADING'

Shutdown clamd

import pyclamd
pyclamd.init_unix_socket('/tmp/clamd.socket')
pyclamd.shutdown()

The module raises various exceptions that you will need to catch, please refer to the documentation for details.

Home page

• http://alastairs-place.net/projects/pwtools/

Use

pwtools is a Python package that provides the ability to generate passwords, and also allows you to test them to ensure that they are reasonably secure.

The algorithms used were borrowed from the Openwall Project’s passwdqc project, but have been re-implemented in Python for increased portability.

Installation

This package is not available on the cheeseshop (PYPI) so you need to install it from the Mercurial repository.

pip install hg+http://alastairs-place.net/hg/pwtools

Usage

Generate a strong password:

from pwtools import PasswordGenerator
pwgen = PasswordGenerator()
pwgen.generate()

Output:

'amaze*Period&Thirst'

Check password strength:

from pwtools import PasswordChecker
pwchecker = PasswordChecker('/usr/share/dict/words')
pwchecker.checkPassword('password')
pwchecker.checkPassword('zxcvbnm')
pwchecker.checkPassword('123456abcdef')
pwchecker.checkPassword('m1ll10n')
pwchecker.checkPassword('amaze*Period&Thirst')

Output:

'too simple (not enough different kinds of character)'
'too simple (not enough different kinds of character)'
'based on a common sequence of characters'
'too simple (not enough different kinds of character)'
False

Home page

• http://slimit.org/

Use

SlimIt is a JavaScript minifier written in Python. It compiles JavaScript into more compact code so that it downloads and runs faster.

SlimIt also provides a library that includes a JavaScript parser, lexer, pretty printer and a tree visitor.

Installation

pip install slimit

Usage

The package provides a command line interface as well as Python functions.

Python functions

Minify Javascript

from slimit import minify
minified = minify(open('jquery-1.7.2.js').read(), mangle=True, mangle_toplevel=True)
print minified

Modify Javascript within Python and beautify it

This example is taken directly from the documentation. It modifies the counter variable changing it from "i" to "hello" and formats it in a more readable style.

from slimit.parser import Parser
from slimit.visitors import nodevisitor
from slimit import ast

parser = Parser()
tree = parser.parse('for(var i=0; i<10; i++) {var x=5+i;}')
for node in nodevisitor.visit(tree):
    if isinstance(node, ast.Identifier) and node.value == 'i':
        node.value = 'hello'
print tree.to_ecma()

Output:

for (var hello = 0; hello < 10; hello++) {
  var x = 5 + hello;
}

Command line

slimit --mangle < jquery-1.7.2.js > jquery-1.7.2.slimit.default.js

Performance

The performance is very good, most times it creates smaller files than the YUI compresser. I tested minifying Jquery using 3 javascript minification tools:

• jsmin
• yuicompressor
• slimit

The results are below.

-rw-r--r--  1 andrew  staff   247K Mar 21 21:46 jquery-1.7.2.js
-rw-r--r--  1 andrew  staff   138K Apr 30 08:26 jquery-1.7.2.jsmin.js
-rw-r--r--  1 andrew  staff    96K Apr 30 08:22 jquery-1.7.2.slimit.js
-rw-r--r--  1 andrew  staff   103K Apr 30 08:19 jquery-1.7.2.yui.js

And there is more

Slimit also exposes JavaScript parser and lexer functions which you can use within your code, please refer to the documentation for usage information.

The cssmin package is used to minify css files.

Home page

• https://github.com/zacharyvoase/cssmin

Use

cssmin is a Python port of the YUI CSS Compressor. It is used to minify css files, which helps improve web application performance by reducing page load times.

Installation

pip install cssmin

Usage

The package provides a command line interface as well as Python functions.

Python function

import cssmin
minified = cssmin.cssmin(open('style.css').read())
print minified

Commandline

cssmin --wrap 1000 < style.css > style.min.css

Thats it, nice and sweet.

Home page

• http://www.mindrot.org/projects/py-bcrypt/

Use

py-bcrypt is a Python wrapper of OpenBSD's Blowfish password hashing code, as described in "A Future-Adaptable Password Scheme" by Niels Provos and David Mazières.

This system hashes passwords using a version of Bruce Schneier's Blowfish block cipher with modifications designed to raise the cost of off-line password cracking and frustrate fast hardware implementation. The computation cost of the algorithm is parametised, so it can be increased as computers get faster. The intent is to make a compromise of a password database less likely to result in an attacker gaining knowledge of the plaintext passwords (e.g. using John the Ripper).

The module allows you to safely store passwords using Python.

Installation

pip install py-bcrypt

Usage

The usage is very simple.

import bcrypt
# generate the hash
hashed = bcrypt.hashpw('password', bcrypt.gensalt())
# compare hash with a password
if bcrypt.hashpw('password', hashed) == hashed:
    print "matched"
else:
    print "failed"
print hashed

Output:

'$2a$12$rK9jIjKu3wRMEf/E6pv9uuqXFmeg.WlBA3jT7uwKb71o1ZSt1xIIW'

Thats it, nice and sweet.

Home page

• http://www.noah.org/wiki/Pexpect

Use

Pexpect is a pure Python module that makes Python a better tool for controlling and automating other programs. Pexpect is similar to the Don Libes Expect system, but Pexpect as a different interface that is easier to understand.

It runs programs and watches output. When output matches a given pattern Pexpect can respond as if a human were typing responses.

Pexpect can be used for automation, testing, and screen scraping. Pexpect can be used for automating interactive console applications such as ssh, ftp, passwd, telnet, etc.

Unlike other Expect-like modules for Python Pexpect does not require TCL or Expect nor does it require C extensions to be compiled. It should work on any platform that supports the standard Python pty module.

Installation

pip install pexpect

Usage

In the following example i will show you how to automate the creation of a super user in Django. The Django manage.py command is used to create user accounts, it has a no input --noinput option but this option does not allow you to set the password. With this example you are able to create the user account and set the password as if you were typing in the responses.

import pexpect
child = pexpect.spawn('manage.py createsuperuser')
child.expect('Username: ')
child.sendline('username')
child.expect('E-mail address: ')
child.sendline('username@example.com')
child.expect('Password: ')
child.sendline('my weak password')
child.expect('\r\n')
child.expect('Password \(again\): ')
child.sendline('my weak password')

You can use pexpect to do all the things you could do using expect, the source tar ball contains several examples, showing how you can automate the following:

• Detect if one IP address is taking up an excessive number of connections by running netstat
• Creates SSH connections to a list of hosts and send commands to all the hosts
• Start a subshell and log all input and output to a file like the script command
• Clean up binary files improperly added to CVS
• Connect to an ftp site and do a few ftp tasks
• Run a sequence of commands on a remote host using SSH
• Login to each given server and change the password of the given user
• Starts an SSH tunnel, monitor the connection and restarts the tunnel if it goes down

And there is more

If you would like to script a process that requires human interaction then pexpect is for you, please refer to the documentation for more information.