deviceauth

README

MOVED

This repository has been moved to the mender-server monorepo: https://github.com/mendersoftware/mender-server

Mender: Device Authentication Service

Mender is an open source over-the-air (OTA) software updater for embedded Linux devices. Mender comprises a client running at the embedded device, as well as a server that manages deployments across many devices.

This repository contains the Mender Device Authentication service, which is part of the Mender server. The Mender server is designed as a microservices architecture and comprises several repositories.

Device Authentication is responsible for issuing, maintaining and verifying JWT authentication tokens used by devices in Mender API calls. A token is issued as a result of a successful bootstrap request, whereby the device presents its vendor-specific identity attributes, and can be admitted in the the system by the administrator. Each subsequent device-specific API call is then internally routed to this service for token verification. At any time, the administrator can also revoke the JWT in case it was compromised.

Getting started

To start using Mender, we recommend that you begin with the Getting started section in the Mender documentation.

Building from source

As the Mender server is designed as microservices architecture, it requires several repositories to be built to be fully functional. If you are testing the Mender server it is therefore easier to follow the getting started section above as it integrates these services.

If you would like to build the Device Authentication service independently, you can follow these steps:

git clone https://github.com/mendersoftware/deviceauth.git
cd deviceauth
go build

Configuration

The service can be configured by:

• providing configuration file (supports JSON, TOML, YAML and HCL formatting). The default configuration file is provided to be downloaded from config.yaml.
• setting environment variables. The service will check for a environment variable with a name matching the key uppercased and prefixed with "DEVICEAUTH_". Eg. for "listen" the variable name is "DEVICEAUTH_LISTEN".

Contributing

We welcome and ask for your contribution. If you would like to contribute to Mender, please read our guide on how to best get started contributing code or documentation.

License

Mender is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Security disclosure

We take security very seriously. If you come across any issue regarding security, please disclose the information by sending an email to security@mender.io. Please do not create a new public issue. We thank you in advance for your cooperation.

Connect with us

• Join the Mender Hub discussion forum
• Follow us on Twitter. Please feel free to tweet us questions.
• Fork us on Github
• Create an issue in the bugtracker
• Email us at contact@mender.io
• Connect to the #mender IRC channel on Libera

Documentation

Overview

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.