dusk-network/dusk-pki

Dusk Public Key Infrastructure

dusk-pki's Issues

Add `deprecated` badge for crates.io

Summary

Add a badge that marks this repository as deprecated on crates.io

Detailed Description

All keys moved into either dusk-schnorr or phoenix-core:

Key	new location
SecretKey	dusk_schnorr::NoteSecretKey
PublicKey	dusk_schnorr::NotePublicKey
SecretSpendKey	phoenix_core::SecretKey
PublicSpendKey	phoenix_core::PublicKey
StealthAddress	phoenix_core::StealthAddress
ViewKey	phoenix_core::ViewKey

Related issues

dusk-network/schnorr#80
dusk-network/phoenix#126

Implement `const` fns for `PublicKey` and `StealthAddress`

Describe what you want implemented
Implement constant functions to allow the user to create public keys and stealth addresses as constants

Describe "Why" this is needed
We have some special use-cases for constant one-time keys in Rusk where we need to pad zeroed outputs to transactions in order to satisfy the ZK circuit.

Describe alternatives you've considered
Using runtime calculation for objects that should be constants is cryptic and inefficient

StealthAddress should be derived from a Public Key

Derive Default for exported crate data structures

It's starting to be painful and verbose to derive Default for structures that contain dusk-pki structs such as StealthAddress.

So it would be really nice to implement them.

Implement `rkyv` related traits

Describe what you want implemented
rkyv related traits should be implemented for at least StealthAddress to allow for passing them through the host/VM boundary.

Describe "Why" this is needed
This is necessary to be able to pass these structures to a smart contract running on the virtual machine.

Describe alternatives you've considered
N/A

Additional context
The job of serialization and de-serialization used to be performed by canonical. Due to the increased costs it entailed, we decided to architect the new VM to allow rkyvable used as transaction arguments.

Derive `Default` for `PublicKey`

Summary

Citadel requires it for handling the License struct.

Use truncated hashing techniqe to obtain the crate structures

Will be possible once dusk-network/Poseidon252#155 is implemented and will allow us to have much less trouble in our circuits when we need to demonstrate that some of our keys are consistently built correctly.

Add a method to generate a pair of keys from a given RNG

Summary

Currently we lack a method to generate both pairs (SecretKey / PublicKey and SecretSpendKey / PublicSpendKey) in one call, as pair.

Possible solution design or implementation

N/A

Additional context

N/A

Implement Eq & PartialEq for PublicKey

Add proper README.md and better documentation

The README.md shouldn't be empty and probably we should have a more descriptive docs as well

Migrate to Poseidon 0.22.0-rc.0

Change the hash used for the note keys to Blake

Describe what you want implemented
Currently we use Poseidon to compute the hashes involved in the generation of the note keys (stealth address). As these operations always happen out of the circuit, replacing Poseidon by a more efficient hash function (not intended to be computed in-circuit) like Blake2b, would be a better solution.

Implement dusk-pki CI in Github Actions

Rename `Public/SecretKey` into `Note-Public/SecretKey` and `Public/SecretSpendKey` into `Public/SecretKey`

Summary

We want to do a rename of the PublicKey and SecretKey structures to NotePublicKey and NoteSecretKey, respectively, as well as rename the PublicSpendKey and SecretSpendKey to PublicKey and SecretKey, respectively.
This is to better reflect their usage in our transaction model, and avoid any confusion when comparing documentation with this code.

Possible solution design or implementation

N/A

Additional context

The ideal situation would be that this repository would be independent of phoenix. This is, however, already not the case, since we use words like "Spend" and offer functionality such as SecretSpendKey::sk_r, which are clearly designed for use by phoenix.

Update to `dusk-poseidon` `0.23`

Describe what you want implemented
Update dusk-poseidon dependency to 0.23.

Describe "Why" this is needed
dusk-plonk 0.9 was released with major API improvements and general bug fixes. It is desirable to have these improvements available. dusk-poseidon 0.23 contemplates these features.

Describe alternatives you've considered
N/A

Additional context
N/A

dusk-pki not compiling

We need to fix the master branch since it's not compiling and that's a dependency for a lot of repos that is causing failures.

Release 0.7.0

Upgrade poseidon252 to v0.17.0

Integrate PublicKey and SecretKey from Schnorr

Dusk PKI should be the central place that handles Public and Secret Keys; currently the structure are split among this repo and schnorr repo.

The Secret / Public Keys of schnorr should be moved here, and schnorr should relies on dusk-pki to handle the keys – except for PublicKeyPair.

Migrate the repo to canonical v0.6

Wrong dependency flag for jubjub

dusk-pki is importing jubjub without default-features=false. This cause the dependencies of pki to break for no-std environments

Export main structures in no_std & update deps

Since we've been mainly focused on have the contracts working with PoseidonTrees inside, we have left appart the repos that were not taking part in the contract. And one of them is dusk-pki.

Therefore, we need to update it's dependencies. We also need to enable a no_std compilation for the main structures exported and finally check that the canon features adapt nicely to that.

Bump BLS Plonk

Wrong subtle dep

subtle should use flag default-features=false to not break no-std dependencies

Implement zerioize for critical `clear_on_drop` data structures

`rand_core` shouldn't require default features

Bump tags

Due to a change in the versions, the tag needs to be changed. This ought to be a minor bump.

Update poseidon to crates-io v0.18

Compile the library for WebAssembly and test / bench it on browsers

This library should be included in the wallet add-on and therefore we should be able to compile it as WASM.

Browsers

• Chrome (Desktop, latest version)
• Firefox (Desktop, latest version)

Prepare dusk-pki to be published on crates.io

Change Rustfmt Action to run on nightly toolchain

Bump verisons

Due to large changes in the versions, all dependant imports on BLS and JubJub need to be altered.

Deprecate this repo

Summary

As result of the first day of Zedger Work Week we agreed on deprecate this repository in favor of Make dusk-schnorr the equivalent of bls12_381-sign for Jubjub curve and Add Phoenix protocol's related keys.

Possible solution design or implementation

See the links above.

Additional context

We first split the keys in two domain based on the curve field: Jubjub and bls12_381. Then we notice that where the bls12_381-sign contains both the keys definition, and the signature's algorithm, for the Jubjub field that was split in two: dusk-pki, that contains the keys definition, and dusk-schnorr that contains the signature's algorithm.

Therefore we decided to move the "Jubjub keys" together with the algorithm (see []). At that point the only keys left here were related to phoenix, so we decided to move them there: at this point this repo become obsolete and should be deprecated.

Derive `Default` for StealthAddress

For Citadel, we need StealthAddress to derive Default.

Update dusk-poseidon to 0.20

Remove unnecessary references across the code