Skip to content

Election_Event_Logging_UML_documentation.md

Latest commit

 

History

History
166 lines (120 loc) · 13.2 KB

Election_Event_Logging_UML_documentation.md

File metadata and controls

166 lines (120 loc) · 13.2 KB

EventLoggingV1

Enumerations

The DeviceType Enumeration

Image of DeviceType

Used in Device::Type to describe the type or usage of the device generating the event.

Name Value
adjudication Electronic adjudication function for reviewing absentee/mail-in ballots anomalies (blanks/overvotes/write-ins/unreadable ballots).
ballot-activation Devices for enabling a vote capture device (VCD) to display a ballot, possibly directly connected to the VCD or through a smart card interface.
bmd Ballot marking devices (voter facing).
ballot-printing Marked ballot printing devices (voter facing).
blank-ballot-printing On-demand blank ballot printers.
dre Electronic voter stations, standalone or daisy chained to a DRE-controller (voter facing).
dre-controller Network controller for electronic voting (poll worker facing).
electronic-cast DREs, or other devices that store cast vote records electronically (voter facing).
electronic-cast-paper DREs, or devices that store cast vote records electronically and also print a paper record (voter facing).
electronic-poll-book Electronic poll book devices.
ems Election management systems, including for pre- and post-election administration and reporting functions.
scan-batch Scanning devices for batches of ballots, auto-feeding, e.g., Central Count (poll worker facing).
scan-single Scanning devices for single-sheets, e.g., Precinct Count (voter facing), but could be used for Central Count by an election official.
transmission-sending Remote transmission clients, e.g., for sending of unofficial results from a remote location to a central location (sending station).
transmission-receiving Remote transmission hosts, e.g., for the receiving of unofficial results at a central location from a remote location (receiving station).
other Used when no other value in this enumeration applies.

The EventDispositionType Enumeration

Image of EventDispositionType

Used in Event::Disposition for types of event dispositions.

Name Value
failure For a failure disposition.
na Used when the disposition is not applicable or there is no disposition.
success For a successful disposition.
other Used when no other value in this enumeration applies.

The HashType Enumeration

Image of HashType

Used in Hash::Type to indicate the type of hash being used for an image file.

Name Value
md6 To indicate that the MD6 message digest algorithm is being used.
sha-256 To indicate that the SHA 256-bit signature is being used.
sha-512 To indicate that the SHA 512-bit (32-byte) signature is being used.
other Used when no other value in this enumeration applies.

Classes

The Device Class

Image of Device

Device contains information about the device generating election event logs. Id is the only required attribute, all other attributes are optional. If the device type is not found in the DeviceType enumeration, Type is ‘other’ and OtherType contains the appropriate type.

Attribute Multiplicity Type Attribute Description
Details 0..1 String Used to associate any details with the event log.
{Event} 0..* Event Used to describe a logged event.
HashType 0..1 HashType The type of the hash, from the HashType enumeration.
OtherHashType 0..1 String If HashType is 'other', the type of the hash.
Id 1 String A serial number or otherwise identifier associated with the device.
Manufacturer 0..1 String Manufacturer of the device.
Model 0..1 String Model of the device.
Type 0..1 DeviceType Enumerated usage of the device, e.g., ems, scan-single, etc.
OtherType 0..1 String Used when Type is ‘other’.
Version 0..1 String Version identification of the device.

The ElectionEventLog Class

Image of ElectionEventLog

ElectionEventLog is the root class. It includes Device for identifying the device(s) generating the election events, the date and time when the election event log was created, and an identification of the election. Details is used as needed for additional description/details. HashType is used to specify a cryptographic hash associated with the events, that is, an event log entry, using values from the HashType enumeration. If the type of hash is not found in the HashType enumeration, HashType is ‘other’ and OtherHashType contains the type of hash.

Attribute Multiplicity Type Attribute Description
Details 0..1 String Used to associate any details with the event log.
{Device} 0..* Device Used to describe the device(s) generating the election events.
ElectionId 0..1 String Identifies the election associated with the log.
GeneratedTime 1 dateTime Identifies the date and time the log was generated.

The ElectionEventLogDocumentation Class

Image of ElectionEventLogDocumentation

ElectionEventLogDocumention is the root class. It includes EventIdDescription and EventTypeDescription, as well as other information for identifying the specific device associated with the election event documentation.

Attribute Multiplicity Type Attribute Description
DeviceId 0..1 String A serial number or otherwise identifier associated with the device.
DeviceManufacturer 1 String Manufacturer of the device.
DeviceModel 1 String Model of the device.
DeviceVersion 0..1 String Version identification of the device.
{EventIdDescription} 1..* EventIdDescription For associating a description with an event ID.
{EventTypeDescription} 1..* EventTypeDescription For associating a description with an event type.
GeneratedDate 1 date Identifies the date the documentation report was generated.

The Event Class

Image of Event

Event holds information about a specific event. Severity is an optional attribute for describing a severity indication for the event. If the event disposition is not found in the EventDispositionType enumeration, Disposition is ‘other’ and OtherDisposition contains the other disposition.

Attribute Multiplicity Type Attribute Description
Description 0..1 String Used for a brief description of the event.
Details 0..1 String Used for additional information about the event, e.g., vendor reserved information.
Disposition 1 EventDispositionType The disposition, e.g., success or failure, of the event.
OtherDisposition 0..1 String Used when Disposition is ‘other’.
Hash 0..1 String Contains a cryptographic hash of the event, encoded as a string.
Id 1 String An identifier associated with the event.
Sequence 1 String A sequence number/string to uniquely identify the event in the log file.
Severity 0..1 String Used for an indication of the severity of the event, as determined by the device vendor.
TimeStamp 1 dateTime Identifies the date and time the event was generated.
Type 1 String Used for the type of event, as determined by the device vendor.
UserId 0..1 String An identifier associated with a user, as relevant.

The EventIdDescription Class

Image of EventIdDescription

For associating a brief description with an election event ID, used in ElectionEventLogDocumentation::EventIdDescription.

Attribute Multiplicity Type Attribute Description
Description 1 String Used for a brief description of the event.
Id 1 String An identifier associated with the event.

The EventTypeDescription Class

Image of EventTypeDescription

For associating a description with an election event log type, used in ElectionEventLogDocumentation::EventTypeDescription.

Attribute Multiplicity Type Attribute Description
Description 1 String Used for a description of the event type.
Type 1 String An identifier associated with the event type.