Refactoring Objects: ADR-002

[prnk28]

Stakeholders

• @prnk28
• @ntindle
• @mcjcloud
• @joshLong145
• @Peyton232

Summary

By utilizing IPLD based schemas as the mechanism for Encrypting/Decrypting App specific objects, sonr-io/core/ipfs will be able to easily add signed objects to the User Bucket. The following components become affected:

• sonr-io/core/ipfs
  • AddSignedObject
  • Implement IPLD Codec
  • DAG Mechanism
  • AddEncryptedObject
  • Follow Secret Path
• sonr-io/core/did
  • Authenticate
  • Implement Provider, Resolver interfaces
  • CreateJWS
  • CreateJWE
  • VerifyJWS
  • VerifyJWE
• sonr-io/blockchain/*/object/*
  • Remove existing fieldvalues
  • Implement only label and field kind
• sonr-io/core/motor
  • Interaction API for Highway

Steps

1. Implement go-ipld-prime in core/ipfs for adding structs into IPFS
2. Implement JOSE methods in core/did
3. Refactor ObjectDoc proto in blockchain/proto/object to follow IPLD Schema method
4. Modify core/ipfs to enable DAG schema type using provided ObjectDoc to verify fields
5. Implement CID Linksystem in core/ipfs and map to ObjectDoc provided schema (optional)
6. Create JWS and JWE methods in core/did
7. Implement Highway API interaction methods for Motor Node
   • AccessApp()
   • InteractBucket()
   • InteractObject()
   • ListenChannel()
   • LinkDevice()
   • LinkPeer()
   • ReadBucket()
   • ReadObject()
   • RequestPeer()
   • RespondPeer()
   • Open() - Method returns a stream of all p2p realtime events and opens node to network for interaction

In Depth Details

ObjectDoc Proto

Follow go-ipld-prime/Type as guidelines for how to construct proto file

• Define fields w/ label : string and kind : Enum
• Linked Issue Create QUIC Stream and Pass Chunks with Protobuf Messages #32

JWE & JWS with DID

Implement methods that are already existing in the js-dids package

• CreateDagJWS()
• CreateDagJWE()
• VerifyJWS()
• VerifyJWE()

Resources

• JS Tutorial Article which served as Basis
• IPLD DAG-JSON Docs
• JWT, JWS, and JWE Overview