Skip to content

Checksums

Attribute Value Detail
name checksum Used in schema definitions
label Checksum plural: Checksums
group checksums Used in search indexing to query all properties of a given type
matchable Suitable for use in entity matching
pivot Suitable for use as a pivot point for connecting to other entities

Python API

followthemoney.types.ChecksumType

Bases: PropertyType

Content hashes calculated using SHA1. Checksum references are used by document-typed entities in Aleph to refer to raw data in the archive (e.g. the document from which the entity is extracted).

Unfortunately, this has some security implications: in order to avoid people getting access to documents for which they know the checksum, properties of this type are scrubbed when submitted via the normal API. Checksums can only be defined by uploading a document to be ingested.

Source code in followthemoney/types/checksum.py
class ChecksumType(PropertyType):
    """Content hashes calculated using SHA1. Checksum references are used by
    document-typed entities in Aleph to refer to raw data in the archive
    (e.g. the document from which the entity is extracted).

    Unfortunately, this has some security implications: in order to avoid people
    getting access to documents for which they know the checksum, properties
    of this type are scrubbed when submitted via the normal API. Checksums can only
    be defined by uploading a document to be ingested."""

    name = "checksum"
    group = "checksums"
    label = _("Checksum")
    plural = _("Checksums")
    matchable = True
    pivot = True
    max_length = 40