COMPLETED

API Security

G
Gareth
7 months ago 7 votes 2 comments

The API is useful, but powerful.

As it can modify calls (e.g. turning off recording) it would be good to add some security, e.g. some of:

  • a token parameter?

  • allow/blocklists lists of IPs allowed to access it?

  • more granular control of what interfaces/IP were bound to (rather than all/localhost)

2 Comments

T
Ted Mielczarek 7 months ago

A straightforward way to implement this would be for MuteDeck to generate a random value on startup and write it to a fixed location (e.g. ~/Library/Application Support/MuteDeck/MuteDeck/api-token) and then require that all API requests include that token. This is functionally similar to a CSRF token.

M
Martijn Smit Team 6 days ago

This needed to be as user-friendly as possible, which took a while to design and orchestrate. MuteDeck v4.13 and all plugins now have a guided pairing setup. This means the MuteDeck API can be restricted to allowed/authenticated requests only, and the plugins will pair with MuteDeck by asking permission first and the user needs to explicitly allow the connection before it can be made active.

The strictness of the connections can be changed in Settings > Plugins & API > Plugins without authentication. That's currently (v4.13) default to Allow, and I'm phasing it to restricted by default in the next coming versions. Just to make sure backwards compatibility works and no one gets all connections blocked all of a sudden. 😉

Sign in to comment.

Support

Details

Status
COMPLETED
Submitted
Mar 21, 2026
Updated
6 days ago