Skip to content

Commit af3e987

Browse files
AbdulboisAbdulbois
committed
Merge branch 'master' into improve-error-message-texts
# Conflicts: # x/pki/keeper/msg_server_remove_noc_x_509_root_cert.go
2 parents 0753e5f + ac58d9f commit af3e987

11 files changed

+100
-55
lines changed

‎.github/.wordlist.txt

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ lldbout
3636
localnet
3737
MainNet
3838
multiclient
39+
Nano
3940
NotFound
4041
ol
4142
openapi

‎.github/workflows/verify.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ jobs:
5656
if: needs.changes.outputs.workflows == 'true'
5757
name: Run actionlint tool to verify lint issues in GitHub actions
5858
runs-on: ubuntu-latest
59-
# needs:
60-
# - changes
59+
needs:
60+
- changes
6161
steps:
6262
- uses: actions/checkout@master
6363
- uses: reviewdog/action-actionlint@v1

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -229,3 +229,4 @@ the following instructions from [how-to.md](docs/how-to.md) can be used for ever
229229
- [Pool Upgrade How To Guide](docs/pool-upgrade-how-to.md)
230230
- [CometBFT](https://cometbft.com/)
231231
- [Cosmos SDK](https://cosmos.network/sdk)
232+
- [Ledger Nano Support](docs/ledger-nano.md)

‎docs/design/noc-root-cert-design.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A Vendor with DCL write privilege can submit a transaction to remove a NOC root
1313

1414
## Certificate Schema
1515

16-
To distinguesh NOC root certificates from others, an `isNOC` boolean field will be added to the [certificates](https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/proto/pki/certificate.proto) schema
16+
To distinguesh NOC root certificates from others, an `isNOC` boolean field will be added to the [certificates](https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/proto/zigbeealliance/distributedcomplianceledger/pki/certificate.proto) schema.
1717

1818
## Transactions
1919

‎docs/ledger-nano.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Ledger Nano Support
2+
3+
## Prepare Ledger Nano Device to Use with DCL
4+
5+
### Step 1: Install Ledger Live
6+
7+
Download and install Ledger Live: Go to the [Ledger Live download page](https://www.ledger.com/ledger-live) and select the version suitable for your operating system. Follow the on-screen instructions to install it.
8+
9+
<!-- markdown-link-check-disable -->
10+
### Step 2: Set Up Your Ledger Device
11+
12+
Initialize Your Ledger Device: If this is your first time using your Ledger, you will need to configure it. Follow the instructions to choose a PIN and securely write down the mnemonic seed phrase that appears. This seed is crucial for recovery and is compatible with DCL. Detailed instructions are available [here](https://support.ledger.com/hc/en-us/articles/4416927988625-Set-up-your-Ledger-Nano-S-Plus?docs=true).
13+
14+
### Step 3: Install the Cosmos (ATOM) app on your Ledger device
15+
16+
To use the Ledger Nano with DCL, you first need to install the Cosmos (ATOM) application. Connect your Ledger device to your computer, open Ledger Live, and navigate to the 'Manager' tab. Allow the manager on your Ledger device, find the Cosmos (ATOM) app in the catalog, and click 'Install'. For detailed instructions, visit the [Cosmos (ATOM) documentation page](https://support.ledger.com/hc/en-us/articles/360013713840-Cosmos-ATOM?docs=true).
17+
<!-- markdown-link-check-enable -->
18+
19+
## Using Ledger Device with DCL CLI
20+
21+
To use the DCL (dcld) command line interface, it must first be installed on your computer. You can find the installation instructions in the [Quick start guide](https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/50ef77243b49764f474e545cc4be2beee4793ed0/docs/quickStartGuide.adoc#L3).
22+
23+
### Add your Ledger Key
24+
25+
1. Connect and unlock your Ledger device.
26+
2. Open the Cosmos app on your Ledger.
27+
3. Add a new account in dcld using your Ledger key. Enter the following command:
28+
29+
```bash
30+
dcld keys add <keyName> --ledger
31+
```
32+
33+
4. Approve the addition of the account on your Ledger device within the Cosmos app.
34+
5. Verify the account has been added by using the following command:
35+
36+
```bash
37+
dcld keys show <keyName>
38+
```
39+
40+
### Signing and Sending Transactions
41+
42+
To sign and send transactions using your Ledger Nano device, follow these steps:
43+
44+
1. Ensure your Ledger device is unlocked and that the Cosmos app is open.
45+
2. Initiate the transaction using the DCL CLI. Replace <transaction_command> with the specific command for your transaction:
46+
47+
```bash
48+
dcld <transaction_command> --from <keyName> --ledger
49+
```
50+
51+
3. Review and confirm the transaction details on your Ledger device. Carefully inspect each aspect of the transaction JSON displayed on the screen.
52+
53+
## Using DCL with a Web Browser
54+
55+
This section explains how to use a Ledger device to sign DCL transactions via the web UI using the Keplr wallet.
56+
57+
- Install the Keplr Wallet as a browser extension from the official Keplr website, available for Chrome or other supported browsers.
58+
- Connect your Ledger device to your computer and ensure the Cosmos app is open on the device.
59+
- Click on the Keplr extension icon and select "Connect Hardware Wallet." If you have previously created a wallet in Keplr, you will need to add a new wallet before selecting "Connect Hardware Wallet" again.
60+
- Confirm that your Ledger device is unlocked with the Cosmos app active. Then, follow the on-screen instructions provided by the Keplr pop-up.
61+
62+
Now, you are ready to sign transactions using your Ledger Nano and the Keplr wallet. Each time you initiate a transaction, you will need to confirm it on your Ledger device following prompts from the Keplr interface.

‎docs/quickStartGuide.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Please refer to https://github.com/zigbee-alliance/distributed-compliance-ledger
99
=== DCL CLI setup
1010
These steps will configure `dcld` on Ubuntu platform.
1111

12-
==== GOLANG 1.3+
13-
Make sure you have goLang 1.3+ installed.
12+
==== GOLANG 1.20+
13+
Make sure you have goLang 1.20+ installed.
1414
Ubuntu
1515
https://khongwooilee.medium.com/how-to-update-the-go-version-6065f5c8c3ec
1616
MacOS
1717
https://www.jajaldoang.com/post/how-to-update-golang
1818

1919
==== Download Pre Compiled `dcld`
20-
A pre-built version of DCL for Ubuntu: https://github.com/zigbee-alliance/distributed-compliance-ledger/releases/download/v0.12.0/dcld, so no need to clone the repo and run make at all.
20+
A pre-built version of DCL for Ubuntu can be found at: https://github.com/zigbee-alliance/distributed-compliance-ledger/releases/download/{latest}/dcld, so no need to clone the repository and run 'make' command at all. Ensure to replace {latest} with the latest version of dcld.
2121

2222
==== Download DCL Source Code from repo
2323
.DCL CLI Build

‎x/pki/keeper/keeper.go

+11
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,14 @@ func filterCertificates(certificates *[]*types.Certificate, predicate Certificat
116116

117117
return result
118118
}
119+
120+
func (k msgServer) removeApprovedX509Cert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.ApprovedCertificates, serialNumber string) {
121+
if len(certificates.Certs) == 0 {
122+
k.RemoveApprovedCertificates(ctx, certID.Subject, certID.SubjectKeyId)
123+
k.RemoveApprovedCertificateBySubject(ctx, certID.Subject, certID.SubjectKeyId)
124+
k.RemoveApprovedCertificatesBySubjectKeyID(ctx, certID.Subject, certID.SubjectKeyId)
125+
} else {
126+
k.SetApprovedCertificates(ctx, *certificates)
127+
k.RemoveApprovedCertificatesBySubjectKeyIDAndSerialNumber(ctx, certID.Subject, certID.SubjectKeyId, serialNumber)
128+
}
129+
}

‎x/pki/keeper/msg_server_remove_noc_x_509_ica_cert.go

+3-12
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,14 @@ func (k msgServer) RemoveNocX509IcaCert(goCtx context.Context, msg *types.MsgRem
6161
// Remove from Approved lists
6262
aprCerts, _ := k.GetApprovedCertificates(ctx, msg.Subject, msg.SubjectKeyId)
6363
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &aprCerts.Certs)
64-
k._removeApprovedX509Cert(ctx, certID, &aprCerts, msg.SerialNumber)
64+
k.removeApprovedX509Cert(ctx, certID, &aprCerts, msg.SerialNumber)
6565

6666
// Remove from ICA lists
67-
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &icaCerts.Certs)
68-
k._removeNocX509IcaCert(ctx, certID, &icaCerts, msg.SerialNumber)
67+
k.RemoveNocIcaCertificateBySerialNumber(ctx, icaCerts.Vid, certID.Subject, certID.SubjectKeyId, msg.SerialNumber)
6968
}
7069
if foundRevoked {
7170
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &revCerts.Certs)
72-
k._removeRevokedX509Cert(ctx, certID, &revCerts)
71+
k.removeOrUpdateRevokedX509Cert(ctx, certID, &revCerts)
7372
}
7473
} else {
7574
k.RemoveNocIcaCertificate(ctx, certID.Subject, certID.SubjectKeyId, icaCerts.Vid)
@@ -89,11 +88,3 @@ func (k msgServer) RemoveNocX509IcaCert(goCtx context.Context, msg *types.MsgRem
8988

9089
return &types.MsgRemoveNocX509IcaCertResponse{}, nil
9190
}
92-
93-
func (k msgServer) _removeNocX509IcaCert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.NocIcaCertificates, serialNumber string) {
94-
if len(certificates.Certs) == 0 {
95-
k.RemoveNocIcaCertificate(ctx, certID.Subject, certID.SubjectKeyId, certificates.Vid)
96-
} else {
97-
k.RemoveNocIcaCertificateBySerialNumber(ctx, certificates.Vid, certID.Subject, certID.SubjectKeyId, serialNumber)
98-
}
99-
}

‎x/pki/keeper/msg_server_remove_noc_x_509_root_cert.go

+3-13
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ func (k msgServer) RemoveNocX509RootCert(goCtx context.Context, msg *types.MsgRe
5252
// Remove from Approved lists
5353
aprCerts, _ := k.GetApprovedCertificates(ctx, msg.Subject, msg.SubjectKeyId)
5454
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &aprCerts.Certs)
55-
k._removeApprovedX509Cert(ctx, certID, &aprCerts, msg.SerialNumber)
55+
k.removeApprovedX509Cert(ctx, certID, &aprCerts, msg.SerialNumber)
5656

5757
// Remove from NOC lists
58-
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &nocCerts.Certs)
59-
k._removeNocX509RootCert(ctx, certID, &nocCerts, msg.SerialNumber)
58+
k.RemoveNocRootCertificateBySerialNumber(ctx, nocCerts.Vid, certID.Subject, certID.SubjectKeyId, msg.SerialNumber)
59+
k.RemoveNocRootCertificateByVidSubjectSkidAndSerialNumber(ctx, nocCerts.Vid, certID.Subject, certID.SubjectKeyId, msg.SerialNumber)
6060
}
6161

6262
if foundRevoked {
@@ -86,16 +86,6 @@ func (k msgServer) RemoveNocX509RootCert(goCtx context.Context, msg *types.MsgRe
8686
return &types.MsgRemoveNocX509RootCertResponse{}, nil
8787
}
8888

89-
func (k msgServer) _removeNocX509RootCert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.NocRootCertificatesByVidAndSkid, serialNumber string) {
90-
if len(certificates.Certs) == 0 {
91-
k.RemoveNocRootCertificate(ctx, certificates.Vid, certID.Subject, certID.SubjectKeyId)
92-
k.RemoveNocRootCertificatesByVidAndSkid(ctx, certificates.Vid, certID.SubjectKeyId)
93-
} else {
94-
k.RemoveNocRootCertificateBySerialNumber(ctx, certificates.Vid, certID.Subject, certID.SubjectKeyId, serialNumber)
95-
k.RemoveNocRootCertificateByVidSubjectSkidAndSerialNumber(ctx, certificates.Vid, certID.Subject, certID.SubjectKeyId, serialNumber)
96-
}
97-
}
98-
9989
func (k msgServer) _removeRevokedNocX509RootCert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.RevokedNocRootCertificates) {
10090
if len(certificates.Certs) == 0 {
10191
k.RemoveRevokedNocRootCertificates(ctx, certID.Subject, certID.SubjectKeyId)

‎x/pki/keeper/msg_server_remove_x_509_cert.go

+2-24
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ func (k msgServer) RemoveX509Cert(goCtx context.Context, msg *types.MsgRemoveX50
6060

6161
if foundApproved {
6262
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &aprCerts.Certs)
63-
k._removeApprovedX509Cert(ctx, certID, &aprCerts, msg.SerialNumber)
63+
k.removeApprovedX509Cert(ctx, certID, &aprCerts, msg.SerialNumber)
6464
}
6565
if foundRevoked {
6666
removeCertFromList(certBySerialNumber.Issuer, certBySerialNumber.SerialNumber, &revCerts.Certs)
67-
k._removeRevokedX509Cert(ctx, certID, &revCerts)
67+
k.removeOrUpdateRevokedX509Cert(ctx, certID, &revCerts)
6868
}
6969
} else {
7070
k.RemoveApprovedCertificates(ctx, certID.Subject, certID.SubjectKeyId)
@@ -82,25 +82,3 @@ func (k msgServer) RemoveX509Cert(goCtx context.Context, msg *types.MsgRemoveX50
8282

8383
return &types.MsgRemoveX509CertResponse{}, nil
8484
}
85-
86-
func (k msgServer) _removeApprovedX509Cert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.ApprovedCertificates, serialNumber string) {
87-
if len(certificates.Certs) == 0 {
88-
k.RemoveApprovedCertificates(ctx, certID.Subject, certID.SubjectKeyId)
89-
k.RemoveApprovedCertificateBySubject(ctx, certID.Subject, certID.SubjectKeyId)
90-
k.RemoveApprovedCertificatesBySubjectKeyID(ctx, certID.Subject, certID.SubjectKeyId)
91-
} else {
92-
k.SetApprovedCertificates(ctx, *certificates)
93-
k.RemoveApprovedCertificatesBySubjectKeyIDAndSerialNumber(ctx, certID.Subject, certID.SubjectKeyId, serialNumber)
94-
}
95-
}
96-
97-
func (k msgServer) _removeRevokedX509Cert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.RevokedCertificates) {
98-
if len(certificates.Certs) == 0 {
99-
k.RemoveRevokedCertificates(ctx, certID.Subject, certID.SubjectKeyId)
100-
} else {
101-
k.SetRevokedCertificates(
102-
ctx,
103-
*certificates,
104-
)
105-
}
106-
}

‎x/pki/keeper/revoked_certificates.go

+11
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,14 @@ func (k Keeper) AddRevokedCertificates(ctx sdk.Context, approvedCertificates typ
9696
revokedCertificates.SubjectKeyId,
9797
), b)
9898
}
99+
100+
func (k msgServer) removeOrUpdateRevokedX509Cert(ctx sdk.Context, certID types.CertificateIdentifier, certificates *types.RevokedCertificates) {
101+
if len(certificates.Certs) == 0 {
102+
k.RemoveRevokedCertificates(ctx, certID.Subject, certID.SubjectKeyId)
103+
} else {
104+
k.SetRevokedCertificates(
105+
ctx,
106+
*certificates,
107+
)
108+
}
109+
}

0 commit comments

Comments
 (0)