README
¶
IoT Identity Service
Managing the identity, ownership, credentials and authorization of an IoT device plays a crucial role in the security story. Those details need to be managed as the device goes through its lifecycle - from the manufacturer, distributor, system integrator, to end customer; from commissioning, repurposing to decommissioning the device.
The Identity service plays the role of managing these assets and enabling the connected systems to communicate with secure credentials.
The Identity Service is primarily in focus when the new device comes online. The device will be preconfigured to connect to the Identity Service, providing its Model and Serial assertions. The Identity Service registry will contain the primary ownership details for the device (customer name, store ID) and generates certificates and credentials for the device.
Build
go build bin/identity/identity.go
Run
go run bin/identity/identity.go
Configuration
The service currently runs two different servers for endpoints; one for internal REST APIs used by the management service and one for external clients to enroll. By default those ports are 8031 and 8030 respectively.
Configuration is set using either a YAML file or environment variables. Environment variables are the
YAML keys in uppercase with periods replaced with underscores and prefaced with IOTIDENTITY_. Ex. database.driver
becomes IOTIDENTITY_DATABASE_DRIVER as an environment variable.
Keys
database.driver - The driver to use for the database, supported values are: memory and postgres.
See factory.go
database.connection.string - A connection string formatted for the datasource to consume; passed during factory.
Currently just postgres utilizes this. See config.go for an example.
service.port.internal - The port to use for internal REST API endpoints, consumed by the management service
service.port.enroll - The port to expose for clients to enroll with the Device Management Service
mqtt.url - The URL of the MQTT broker without the port, i.e. localhost or mqtt.somedomain.com
mqtt.port - The MQTT broker port used to communicate with the clients.
mqtt.certificate.path - The path to the certificates to use to connect to the MQTT broker
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth provides a factory to create a gin.HandlerFunc based on specified auth provider
|
Package auth provides a factory to create a gin.HandlerFunc based on specified auth provider |
|
bin
|
|
|
cmd
|
|
|
identity
Package identity contains the root and subcommands for the identity binary
|
Package identity contains the root and subcommands for the identity binary |
|
Package config contains code and data to load configuration for the service
|
Package config contains code and data to load configuration for the service |
|
configkey
Package configkey contains the constant string literal keys for configuration
|
Package configkey contains the constant string literal keys for configuration |
|
Package datastore contains the interface and implementations for the data store backends
|
Package datastore contains the interface and implementations for the data store backends |
|
memory
Package memory is an implementation of a in-memory only datastore
|
Package memory is an implementation of a in-memory only datastore |
|
postgres
Package postgres implements a datastore using the postgres database
|
Package postgres implements a datastore using the postgres database |
|
Package domain provides the identity service specific data structures
|
Package domain provides the identity service specific data structures |
|
middleware
|
|
|
logger
Package logger provides a middleware for logging with Gin using logrus
|
Package logger provides a middleware for logging with Gin using logrus |
|
Package service implements the Identity interface and data access methods
|
Package service implements the Identity interface and data access methods |
|
cert
Package cert provides methods and data types for processing and manipulating service certificates
|
Package cert provides methods and data types for processing and manipulating service certificates |
|
factory
Package factory creates a datasource based on driver type
|
Package factory creates a datasource based on driver type |
|
Package version contains all version information
|
Package version contains all version information |
|
Package web implements the REST API handling and routing
|
Package web implements the REST API handling and routing |