README
¶
go-ticket
Secure and flexible (template and config driven) access control solution for events.
Use cases
Tickets are created and the ticket url is sent to the user.
Staff is authorized by site admin :
- Site administrator log to the /admin page using the superuser password
- Page provides "one-off" authorization "qr-code cards" that can be sent or printed for the event staff, to activate specific roles
- Staff will scan one of the card to get the role associated with it on their smart phone (cookie life set in configuration)
- Currently, for security reasons, role activation cards can only be used once. Admin can generate as many unique activation cards as needed.
Roles include :
- None (default, typically the event visitor)
- Entry : access control, check for ticket validitry and mark as used for entry
- Exit (optionnal) : mark as exited, allowing further reentry
- Review : control current status of ticket, no marking
- Admin, Super : idem, displaying administrative or debugging information.
Scanning a ticket "qr-code card" has various effects depending on the role associated with the device that scans it :
- Role None : diplay ticket in graphical form, to be printed or shown upon entry
- Other staff roles : process ticket and displays its validity, according to the above roles.
Configuration parameters
- See the Conf struct in the conf package
- Configuration is set using, in that order : default, then file, then env, then flags
- When setting paths for templates or config, the first directory that works with the requested file will be the only one used.
Conventions for using templates
- Templates should all be in the same directory, as configured in the config file.
- Template names are the file names (including extension, excluding directory information).
implementation considérations
- Key requirement was to support any generic (free) qr-code or barcode readers on both android or IOS smart phones (for instance, the www.scan.me apps are working perfectly)
- Current implementation stores everything in memory, but architecture makes it easy to implement database supported backend
- Default is to use qr-code, but datamatrix is also available from configuration setting.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app provides server services common to both admin and exploitation.
|
Package app provides server services common to both admin and exploitation. |
|
Package main is the main entrypoint
|
Package main is the main entrypoint |
|
Package common defines common interfaces and types.
|
Package common defines common interfaces and types. |
|
Package conf concentrate all the configuration plumbing.
|
Package conf concentrate all the configuration plumbing. |
|
impl
|
|
|
barcode
Package barcode provide easy to use services to produce barcode images.
|
Package barcode provide easy to use services to produce barcode images. |
|
memstore
Package memstore implements the Store interface with an in-memory data store.
|
Package memstore implements the Store interface with an in-memory data store. |
|
mockmail
Package mockmail is used for debugging mailers.
|
Package mockmail is used for debugging mailers. |
|
sesmail
Package sesmail implements mail sending using AWS SimpleEmailService (SES).
|
Package sesmail implements mail sending using AWS SimpleEmailService (SES). |
Click to show internal directories.
Click to hide internal directories.