mirror of
https://github.com/grafana/grafana.git
synced 2025-09-18 23:43:07 +08:00
7e925a718c
* Draft * Fix? * Prettier * Fix? * Update docs/sources/administration/plugin-management/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Feedback, new docs * Prettier * More feedback * Prettier * Minor edits * Edits * Prettier * Edits * Prettier * Solving conflicts * Prettier * Update docs/sources/administration/plugin-management/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Fix? * Fix? * fix links? * Update plugin-integrate.md * fix link * fix link? * Update plugin-install.md * Update plugin-install.md * fix link * fix link * fix links * Update plugin-types.md * Fix? * Fixing * More links * Final touches * Update docs/sources/administration/plugin-management/plugin-integrate.md Co-authored-by: David Harris <david.harris@grafana.com> * Prettier --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Irene Rodríguez <irene.rodriguez@grafana.com>
81 lines
4.2 KiB
Markdown
81 lines
4.2 KiB
Markdown
---
|
|
title: Plugin signatures
|
|
description: Sign your plugins to make sure they haven't been tampered with.
|
|
labels:
|
|
products:
|
|
- enterprise
|
|
- oss
|
|
- cloud
|
|
keywords:
|
|
- grafana
|
|
- plugins
|
|
- plugin
|
|
- navigation
|
|
- customize
|
|
- configuration
|
|
- grafana.ini
|
|
- sandbox
|
|
- frontend
|
|
weight: 200
|
|
---
|
|
|
|
# Plugin signatures
|
|
|
|
Plugin signature verification, also known as _signing_, is a security measure to make sure plugins haven't been tampered with. Upon loading, Grafana checks to see if a plugin is signed or unsigned when inspecting and verifying its digital signature.
|
|
|
|
Learn more at [plugin policies](https://grafana.com/legal/plugins/).
|
|
|
|
## How does verifiction work?
|
|
|
|
At startup, Grafana verifies the signatures of every plugin in the plugin directory.
|
|
|
|
To see the result of this verification for each plugin, navigate to **Configuration** -> **Plugins**. A signature can have any of the following signature status:
|
|
|
|
| Signature status | Description |
|
|
| ------------------ | ------------------------------------------------------------------------------- |
|
|
| Core | Core plugin built into Grafana. |
|
|
| Invalid signature | The plugin has an invalid signature. |
|
|
| Modified signature | The plugin has changed since it was signed. This may indicate malicious intent. |
|
|
| Unsigned | The plugin is not signed. |
|
|
| Signed | The plugin signature was successfully verified. |
|
|
|
|
### What happens if a plugin is not signed?
|
|
|
|
If a plugin is unsigned, then Grafana neither loads nor starts it. Grafana also writes an error message to the server log:
|
|
|
|
```bash
|
|
WARN[05-26|12:00:00] Some plugin scanning errors were found errors="plugin '<plugin id>' is unsigned, plugin '<plugin id>' has an invalid signature"
|
|
```
|
|
|
|
## Plugin signature levels
|
|
|
|
All plugins are signed under a _signature level_. The signature level determines how the plugin can be distributed.
|
|
|
|
| **Plugin Level** | **Description** |
|
|
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| Private | <p>Private plugins are for use on your own Grafana. They may not be distributed to the Grafana community, and are not published in the Grafana catalog.</p> |
|
|
| Community | <p>Community plugins have dependent technologies that are open source and not for profit.</p><p>Community plugins are published in the official Grafana catalog, and are available to the Grafana community.</p> |
|
|
| Commercial | <p>Commercial plugins have dependent technologies that are closed source or commercially backed.</p><p>Commercial plugins are published on the official Grafana catalog, and are available to the Grafana community.</p> |
|
|
|
|
## Allow unsigned plugins
|
|
|
|
{{< admonition type="note" >}}
|
|
Unsigned plugins are not supported in Grafana Cloud.
|
|
{{< /admonition >}}
|
|
|
|
We strongly recommend that you don't run unsigned plugins in your Grafana instance. However, if you're aware of the risks and you still want to load an unsigned plugin, refer to [Configuration](/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#allow_loading_unsigned_plugins).
|
|
|
|
If you've allowed loading of an unsigned plugin, then Grafana writes a warning message to the server log:
|
|
|
|
```bash
|
|
WARN[06-01|16:45:59] Running an unsigned plugin pluginID=<plugin id>
|
|
```
|
|
|
|
{{< admonition type="note" >}}
|
|
If you're developing a plugin, then you can enable development mode to allow all unsigned plugins.
|
|
{{< /admonition >}}
|
|
|
|
## Sign a plugin you've developed
|
|
|
|
If you are a plugin developer and want to know how to sign your plugin, refer to [Sign a plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin).
|