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

modified totp plugin w.r.t native bip32 support #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

modified totp plugin w.r.t native bip32 support #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions totp-eth-signer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TOTP Ethereum Signer

This plugin implements an Ethereum Signer. Each Ethereum Signer is paired with a `MASTER_KEY`. Several wallets can be added to each Ethereum Signer. Several keys can be added to each wallet.
This plugin implements an Ethereum Signer. Each Ethereum Signer is paired with an HMAC-SEED. Several wallets can be added to each Ethereum Signer. Several keys can be added to each wallet.

A wallet can optionally be registered to support 2FA using Time-based One-Time Passwords (TOTP).

Expand All @@ -18,11 +18,7 @@ The plugin can be used to:

## Setup

- Generate master key manually

- **Example Master Key:** `xprv9s21ZrQH143K31xYSDQpPDxsXRTUcvj2iNHm5NUtrGiGG5e2DtALGdso3pGz6ssrdK4PFmM8NSpSBHNqPqm55Qn3LqFtT2emdEXVYsCzC2U`

- Import master key in SDKMS as secret raw key and name it as `MASTER_KEY`.
- Generate an HMAC type security object in SDKMS

## Register a user for 2FA using TOTP

Expand Down Expand Up @@ -69,6 +65,7 @@ The plugin can be used to:

```
{
"hmac_seed_id": "722adb21-107c-4fdf-b28e-2627437815af",
"operation": "getPubKey",
"walletName": "string",
"keyIndex": "number as string"
Expand All @@ -88,6 +85,7 @@ The plugin can be used to:

```
{
"hmac_seed_id": "<id>",
"operation": "getPubKey",
"walletName": "[email protected]",
"keyIndex": "0"
Expand All @@ -108,6 +106,7 @@ The plugin can be used to:

```
{
"hmac_seed_id": "<id>",
"operation": "sign",
"walletName": "string",
"keyIndex": "number as string",
Expand All @@ -132,6 +131,7 @@ The plugin can be used to:

```
{
"hmac_seed_id": "722adb21-107c-4fdf-b28e-2627437815af",
"operation": "sign",
"walletName": "[email protected]",
"keyIndex": "0",
Expand Down
13 changes: 7 additions & 6 deletions totp-eth-signer/metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"name": "TOTP Ethereum Signer",
"version": 1.0,
"short_description": "This plugin implements an Ethereum Signer. A wallet can optionally be registered to support 2FA using Time-based One Time Passwords (TOTP).",
"release_notes": [
"Initial release"
]
"name": "TOTP Ethereum Signer",
"version": 2.0,
"short_description": "This plugin implements an Ethereum Signer. A wallet can optionally be registered to support 2FA using Time-based One Time Passwords (TOTP).",
"release_notes": [
"Initial release",
"Version 2.0 - Added the support for native BIP0032 from SDKMS, support for both notations, removed unnecessary functions"
]
}
Loading