Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Wallet revoke permissions #145

Merged
merged 12 commits into from
Nov 20, 2023
Merged

Wallet revoke permissions #145

Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5c25773
feat(wallet): Add wallet_revokePermissions JSON-RPC method
alaahd Jun 5, 2023
c87df1f
Merge branch 'main' of github.com:MetaMask/api-specs into wallet-revo…
alaahd Jun 5, 2023
3c0d28b
update the list of optional params for wallet_revokePermissions
alaahd Jun 8, 2023
c9ed7b8
update the description of wallet_revokePermissions
alaahd Jun 8, 2023
d2ef2ef
update wallet_revokePermissions method to allow revoking permissions …
alaahd Jul 11, 2023
b2a3cd3
Merge branch 'main' of github.com:MetaMask/api-specs into wallet-revo…
alaahd Jul 11, 2023
c473b54
Changed revokePermissions to better follow the internal API
shanejonas Nov 15, 2023
5790f1c
Merge branch 'main' into wallet-revoke-permissions
shanejonas Nov 15, 2023
0656f06
Added titles to Caveats and Caveat
shanejonas Nov 15, 2023
5a4e769
Update openrpc.json
shanejonas Nov 16, 2023
803b26d
Update openrpc.json
shanejonas Nov 16, 2023
4b63391
Changed PermissionObject to be its own schema and re-use across reque…
shanejonas Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 85 additions & 22 deletions openrpc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,60 @@
}
]
},
{
"name": "wallet_revokePermissions",
"tags": [
{
"$ref": "#/components/tags/MetaMask"
},
{
"$ref": "#/components/tags/Experimental"
}
],
"summary": "Revoke the current dapp permissions.",
"description": "Revoke previously granted permissions for the current dapp identified by origin",
"paramStructure": "by-name",
shanejonas marked this conversation as resolved.
Show resolved Hide resolved
"params": [
{
"name": "permission",
"required": false,
"schema": {
"type": "object",
"title": "PermissionKey",
"patternProperties": {
".*": {
"type": "object",
"title": "Permission",
"additionalProperties": false,
"properties": {
"caveats": {
"$ref": "#/components/schemas/Caveats"
}
}
}
}
}
}
],
"result": {
"name": "UpdatedPermissionsAfterRevoke",
"description": "The list of the revoked permissions objects",
shanejonas marked this conversation as resolved.
Show resolved Hide resolved
"schema": {
"$ref": "#/components/schemas/PermissionsList"
}
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this response is expected for a dApp that was already connected previously, will the wallet_revokePermissions RPC method will only be accessible to dApps who are connected (ie: its a restricted method)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could. It doesn't have to be though, it could just return an empty array if there are no existing permissions.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just saw the update to the description. Makes sense now 👍

If we are allowing this method without being connected, we should ensure its resistant to timing attacks which can reveal if a specific snap or account exists on the device.

"errors": [],
"examples": [
{
"name": "wallet_revokePermissions example of revoking all permissions",
"params": [],
"result": {
"name": "UpdatedPermissionsAfterRevoke",
"value": []
}
}
]
},
{
"tags": [
{
Expand Down Expand Up @@ -368,7 +422,9 @@
"schema": {
"title": "WatchAssetOptions",
"type": "object",
"required": ["address"],
"required": [
"address"
],
"properties": {
"address": {
"description": "The address of the token contract.",
Expand Down Expand Up @@ -1038,6 +1094,29 @@
}
}
},
"Caveats": {
"description": "Every capability document MAY add restrictions on the way the capability may be used by adding to the caveat property. Capabilities inherit the restrictions from all caveat properties of their parents, and MAY add new caveats in addition to those of their parents.",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"description": "Type of caveat."
},
"value": {
"title": "CaveatValue",
"description": "Value of the caveat."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is technically any. any thoughts on other ways to represent this @BelfordZ

},
"name": {
"title": "Name",
"type": "string",
"description": "Name of the caveat."
}
}
}
},
"Permission": {
"title": "Permission",
"type": "object",
Expand All @@ -1058,27 +1137,7 @@
"type": "string"
},
"caveats": {
"description": "The specific restrictions applied to the permitted method.",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"description": "Type of caveat."
},
"value": {
"title": "CaveatValue",
"description": "Value of the caveat."
},
"name": {
"title": "Name",
"type": "string",
"description": "Name of the caveat."
}
}
}
"$ref": "#/components/schemas/Caveats"
}
}
},
Expand All @@ -1101,6 +1160,10 @@
"Mobile": {
"name": "Mobile",
"description": "Mobile-specific methods."
},
"Experimental": {
"name": "Experimental",
"description": "Experimental methods."
}
},
"errors": {
Expand Down
Loading