open-amt-cloud-toolkit / console

Open AMT Cloud Toolkit

Disclaimer: Production viable releases are tagged and listed under 'Releases'. All other check-ins should be considered 'in-development' and should not be used in production

Open Active Management Technology Cloud Toolkit (Open AMT Cloud Toolkit) offers open-source microservices and libraries to streamline Intel AMT integration, simplifying out-of-band management solutions for Intel vPro Platforms.

For detailed documentation about the Open AMT Cloud Toolkit, see the docs.

Clone

Important! Make sure you clone this repo with the --recursive flag since it uses git submodules.

To clone live, in-development code (main branch):

git clone --recursive https://github.com/open-amt-cloud-toolkit/open-amt-cloud-toolkit.git

Alternatively, for steps to clone and Get Started with one of the tagged releases, see our documentation.

Get Started

There are multiple options to quickly deploy the Open AMT Cloud Toolkit:

Local using Docker

The quickest and easiest option is to set up a local stack using Docker*, view our Documentation Site and click the Getting Started tab for How-To steps and examples.

Cloud using Azure

For more experienced users, deploy the stack on Azure using the 'Deploy to Azure' button below. Note: This requires MPS, RPS, and Sample Web UI images to be built and accessible in a Container Image Registry such as Azure Container Registry (ACR), Docker Hub, or other options.

Optionally, deploy from AzureCLI using the following commands:

az group create --name openamt --location eastus
az deployment group create --resource-group openamt --template-file azureDeploy.json

Additional deployments, such as Kubernetes via Azure (AKS) or AWS (EKS), can be found in our Documentation Site.

Additional Resources

• For detailed documentation and Getting Started, visit the docs site.

• Find a bug? Or have ideas for new features? Open a new Issue.

• Need additional support or want to get the latest news and events about Open AMT? Connect with the team directly through Discord.

  

console's Issues

Create an API in Console to return Certs information (Security settings)

Security Settings tab requirements:

• Show all the certs added to AMT
  • Root Certs
  • SSL Certs (Intermediate or Leaf)
  • Key pairs
• Show TLS setting for remote and local
  • TLS only
  • TLS & non-TLS
  • Mutual-auth TLS only
  • Mutual-auth TLS & non-TLS
• Ability to download a cert

Acceptance Criteria

• Unit Tests
• New REST API in Console
• Postman collection

Console API for AMT Calls

Device details page requirements:

• Get Audit Log
  • Extended Audit Data needs to be decoded
• Get Event Log
• Request user consent
  • Needs to be tested by user w/ CCM
• Send user consent
  • Needs to be tested by user w/ CCM
• Cancel User Consent
  • Needs to be tested by user w/ CCM
• Get Hardware Information
  • AMT Locking due to too many requests from this call
• Get General Settings
• Get power Capabilities
• Get Power State
• Send Power Action
• Send Advanced Power Action
• Get AMT Features
• Set AMT Features
• Get Version

Acceptance Criteria

• Leverage Existing Postman API tests - status codes only
• Unit Tests (Mocking)

DMC Devices

Requirements for Devices screen:

• Ability to add a device, and it will contain below fields.
  • IP address or FQDN or hostname
  • Authentication
    • Digest / None
    • Digest / TLS
  • AMT Username
  • AMT Password
  • Friendly name
    • Get dev teams perspective.
  • Tagging
    • Applicable to per instance for v1.0 (unless a centralized DB is implemented).
• Ability to remove/delete a device.
• Ability to Connect a device.
• Filter by a tag
• Ability to disconnect a device, meaning end the connection to AMT.

Acceptance Criteria

• Postman API tests - status codes only
• Unit Tests (Mocking)

Carry Over - ToDo:

• Ability to edit device details and save
• Ability to search for a device using friendly name or IP Address or FQDN or Tag (on device page/list)
• Filter by group name
• Grouping by tag

Create database for DMC

• Try and keep a similar schema as MPS
• Store information shown on main device list
• Implement interface (SQL)
• Encrypted local database.
• Determine location of embedded DB (Windows & Linux)

Create Get API for Network information

Network settings tab requirements:

• Under WIRED adapter

  • Show information
    • Link Status
    • Link Policy
    • MAC address
    • IPv4 address
    • Gateway
    • Subnet Mask
    • DNS
    • IEEE 802.1x configuration

• Under Wi-Fi adapter information

  • Show information
    • Link Status
    • Link Policy
    • State
    • Radio State
    • MAC address
    • IPv4 address
    • Gateway
    • Subnet Mask
    • DNS
    • Local WIFI profile sync
      • Leave it on all the time

• Show Wi-Fi and IEEE 802.1x Wi-Fi profiles

Acceptance Criteria

• Unit Tests
• New REST API in Console
• Postman collection

Authentication support in Console

As a console user, I'd like to login to the console app only after successful authentication.

Acceptance Criteria

• Only authenticated user is allowed to login (username and password based like MPS)