https://github.com/device-management-toolkit/rpc-go
The Remote Provisioning Client (RPC) communicates with the Manageability Engine Interface (MEI) and Remote Provisioning Service (RPS) interfaces.
https://github.com/device-management-toolkit/rpc-go
active-mangement-technology amt golang intel out-of-band remote-management rpc vpro
Last synced: 15 days ago
JSON representation
The Remote Provisioning Client (RPC) communicates with the Manageability Engine Interface (MEI) and Remote Provisioning Service (RPS) interfaces.
- Host: GitHub
- URL: https://github.com/device-management-toolkit/rpc-go
- Owner: device-management-toolkit
- License: apache-2.0
- Created: 2021-08-23T20:35:55.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2026-05-29T23:10:06.000Z (20 days ago)
- Last Synced: 2026-05-30T01:09:07.706Z (20 days ago)
- Topics: active-mangement-technology, amt, golang, intel, out-of-band, remote-management, rpc, vpro
- Language: Go
- Homepage: https://device-management-toolkit.github.io/docs/
- Size: 3.4 MB
- Stars: 20
- Watchers: 1
- Forks: 24
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Remote Provisioning Client (RPC)
[](https://api.securityscorecards.dev/projects/github.com/device-management-toolkit/rpc-go)
[](https://discord.gg/DKHeUNEWVH)
[](https://hub.docker.com/r/intel/oact-rpc-go)
> 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
RPC is used for activation, deactivation, maintenance, and status of an AMT device
The Remote Provisioning Client (RPC) is an application that assists with activation, configuration, and maintenance of for Intel® AMT devices. RPC provides source code that must be compiled into a binary to run or library for integration with other client applications.
---
## v3.0.0 Beta
The current `main` branch publishes the **v3.0.0 beta** series on the `beta` channel, introducing the new restful profile activation flow, refreshed flag syntax, and CLI/config naming alignment. These changes are **breaking** relative to the v2.x line. To learn more,read about the guidance in the [v3 Changes](./v3.0-changes.md). The v2.x maintenance branch continues to receive updates for teams that are not ready to adopt the beta yet.
---
**For detailed documentation** about Getting Started or other features of the Device Management Toolkit, see the [docs](https://device-management-toolkit.github.io/docs/).
---
## Prerequisites
- [Golang](https://go.dev/dl/)
## Build
### Windows
#### As executable:
```
go build -o rpc.exe ./cmd/rpc/main.go
```
#### As Library:
```
go build -buildmode=c-shared -o rpc.dll ./cmd/rpc
```
### Linux
#### As executable:
```
go build -o rpc ./cmd/rpc/main.go
```
#### As Library:
```
CGO_ENABLED=1 go build -buildmode=c-shared -o librpc.so ./cmd/rpc
```
### Docker image
```bash
docker build -t rpc-go:latest .
```
## Run
Install the executable on a target device and then run from a terminal/shell
command line with adminstrator privileges.
For usage, call the executable with no additional parameters.
### Configuration file
RPC can preload defaults from a YAML configuration file (default: `config.yaml` in the working directory or passed explicitly via `--config `).
See `config.sample.yaml` for a fully documented example containing every command and flag. Typical workflow:
1. Copy the sample: `cp config.sample.yaml config.yaml` (or on Windows `copy config.sample.yaml config.yaml`).
2. Edit only the sections you need (e.g. set `configure: sync-clock: password:` or activation parameters).
3. Run a command using the file:
```shell
rpc --config config.yaml configure sync-clock
```
CLI flags and environment variables always override values loaded from the file.
Sensitive values (passwords, tokens) can also be provided via environment variables (see flag `env:` tags in code) instead of storing in plaintext YAML.
#### Global AMT Password
You can now supply a single global AMT admin password once via either:
```
rpc --amt-password ...
```
or environment variable:
```
set AMT_PASSWORD= # Windows PowerShell
export AMT_PASSWORD= # Linux/macOS
```
All commands that require an AMT password will use this value automatically unless a per-command `--password` is explicitly provided (legacy behavior kept for backward compatibility). The sample config (`config.sample.yaml`) reflects this by using a top-level `amt-password:` key instead of repeating `password:` under each command section.
### Windows
```shell
.\rpc
```
### Linux
```bash
sudo ./rpc
```
### Docker
```bash
$ docker run --rm -it --device /dev/mei0 rpc-go:latest
```
# Dev tips for passing CI Checks
- Ensure code is formatted correctly with `gofumpt -l -w -extra ./`
- Ensure all unit tests pass with `go test ./...`
- Ensure code has been linted with `docker run --rm -v ${pwd}:/app -w /app golangci/golangci-lint:latest golangci-lint run -v`
## Fuzz Testing
The project includes fuzz tests to identify edge cases and potential panics in CLI command parsing. Fuzz testing uses Go's built-in fuzzing support (Go 1.18+).
### Running Fuzz Tests Locally
```bash
# Run quick fuzz tests (30 seconds per test)
make fuzz-short
# Run extended fuzz tests (5 minutes per test)
make fuzz
# Run regression tests with existing corpus only
make fuzz-regression
# Run a specific fuzz test manually
go test -fuzz=FuzzDeactivate -fuzztime=1m ./internal/cli
```
### Continuous Integration
Fuzz tests run automatically in GitHub Actions:
- **Pull Requests & Pushes**: Quick 30-second fuzz tests on each PR
- **Scheduled (Weekly)**: Extended 10-minute fuzz tests every Monday
- **Manual Trigger**: Run with custom duration via workflow_dispatch
If fuzz testing discovers a crash, the failure inputs are uploaded as artifacts for investigation.
### Seed Corpus
The project maintains seed corpus files in `internal/cli/testdata/fuzz/` to ensure effective fuzzing coverage. These files represent valid and edge-case CLI commands that the fuzzer uses as starting points.
## Additional Resources
- For detailed documentation and Getting Started, [visit the docs site](https://device-management-toolkit.github.io/docs).
- Planning to move to v3? Read the [v3 Migration Guide](./migration-guide.md) for breaking changes and upgrade steps.
- Looking to contribute? [Find more information here about contribution guidelines and practices](.\CONTRIBUTING.md).
- Find a bug? Or have ideas for new features? [Open a new Issue](https://github.com/device-management-toolkit/rpc-go/issues).
- Need additional support or want to get the latest news and events about Open AMT? Connect with the team directly through Discord.
[](https://discord.gg/DKHeUNEWVH)