API Usage

warcsigner can be used from other scripts. To sign a warc:

from warcsigner.warcsigner import RSASigner

signer = RSASigner(private_key_file='privatekey.pem')

if signer.sign('my-warc-file.warc.gz'):
    # warc signed successfully

or to verify:

from warcsigner.warcsigner import RSASigner

signer = RSASigner(public_key_file='publickey.pem')

if signer.verify('my-warc-file.warc.gz'):
    # signature verified
else:
    # signature not found/invalid

the sign and verify methods can take either a filename string or a file-like stream object (an object with a read method)

Additionally, upon verification, the signature can be removed:

if signer.verify('my-warc-file.warc.gz', remove=True):
    # signature verified and removed

assert signer.verify('my-warc-file.warc.gz') == False

If the first verify succeeds, the signature will be removed and file truncated to its previous pre-signature size. (The file is unaltered if the verification fails). This may be useful if planning to append to the WARC and then resigning it.

Streaming and seek()

It is possible to use a file-like object which supports a read() instead of a filename.

When a WARC is signed, the signature is appended to the end of the file.

When verifying a file, the seek() may be used to determine the file size and the position of the signature. However, if a size= param is added to verify or verify_stream calls, no seek() calls are made during the verification and the file-like object is consumed linearly. This is specially useful when streaming a file from a remote location and seek() is not available. The total file size must be provided, though.

Public/Private keys are expected to be in .PEM format See the python-rsa formats doc for more information on supported key formats.

Original Stream

In certain situations, it may be useful to return the original, unsigned stream from a signed stream. signer.get_unsigned_stream(stream, size) will return a wrapper for stream which will not include the signature (if present). This is useful if concatenating WARCs without including a signature (and empty record) for each one.