Skip to content

Latest commit

 

History

History
192 lines (144 loc) · 8.9 KB

README.md

File metadata and controls

192 lines (144 loc) · 8.9 KB

go-iden3-auth

Go Reference Go Report Card Test Lint

Library for verification of authorization response messages of communication protocol in JWZ format

go get github.com/iden3/go-iden3-auth/v2

General description:

The goal of iden3auth libraries is to handle authentication messages of communication protocol.

Currently, library implementation includes support of next message types

  1. https://iden3-communication.io/authorization/1.0/request
  2. https://iden3-communication.io/authorization/1.0/response

Auth verification procedure:

  1. JWZ token verification
  2. Zero-knowledge proof verification of request proofs
  3. Query request verification for atomic circuits
  4. Verification of identity and issuer states for atomic circuits

Zero-knowledge proof verification

Groth16 proof are supported by auth library

Verification keys can be provided using KeyLoader interface or EmbeddedKeyLoader can be used to load keys embedded in the library loaders/keys.

Query verification

Proof for each atomic circuit contains public signals that allow extracting user and issuer identifiers, states, signature, challenges, etc.

Circuit public signals marshallers are defined in the go-circuits library.

Verification of user / issuer identity states

The blockchain verification algorithm is used

  1. Gets state from the blockchain (address of id state contract and RPC URL must be provided by the caller of the library):

    1. Empty state is returned - it means that identity state hasn’t been updated or updated state hasn’t been published. We need to compare id and state. If they are different it’s not a genesis state of identity then it’s not valid.
    2. The non-empty state is returned and equals to the state in provided proof which means that the user state is fresh enough and we work with the latest user state.
    3. The non-empty state is returned and it’s not equal to the state that the user has provided. Gets the transition time of the state. The verification party can make a decision if it can accept this state based on that time frame.

  2. Only latest states for user are valid. Any existing issuer state for claim issuance is valid.

Verification of Global Identities State Tree(GIST)

The blockchain verification algorithm is used

  1. Get GIST from the blockchain (address of id state contract and URL must be provided by the caller of the library):
    1. A non-empty GIST is returned, equal to the GIST is provided by the user, it means the user is using the latest state.
    2. The non-empty GIST is returned and it’s not equal to the GIST is provided by a user. Gets the transition time of the GIST. The verification party can make a decision if it can accept this state based on that time frame.

How to use:

  1. go get https://github.com/iden3/go-iden3-auth/v2

  2. Request generation:

    basic auth:

    var request protocol.AuthorizationRequestMessage
// if you need'message' to sign (e.g. vote)
request = auth.CreateAuthorizationRequestWithMessage("test flow", "message to sign","verifier id", "callback url")
// or if you don't need 'message' to sign
request = auth.CreateAuthorizationRequest("test flow","verifier id", "callback url")

    if you want request specific proof (example):

    var mtpProofRequest protocol.ZeroKnowledgeProofRequest
mtpProofRequest.ID = 1
mtpProofRequest.CircuitID = string(circuits.AtomicQueryMTPV2CircuitID)
mtpProofRequest.Query = map[string]interface{}{
   "allowedIssuers": []string{"*"},
   "credentialSubject": map[string]interface{}{
      "countryCode": map[string]interface{}{
         "$nin": []int{840, 120, 340, 509},
      },
   },
   "context": "https://raw.githubusercontent.com/iden3/claim-schema-vocab/main/schemas/json-ld/kyc-v2.json-ld",
   "type":    "KYCCountryOfResidenceCredential",
}
request.Body.Scope = append(request.Body.Scope, mtpProofRequest)

  3. Token verification

    Init Verifier configuration with embeded keys:

    resolvers := map[string]pubsignals.StateResolver{
  "privado:main": state.ETHResolver{
     RPCUrl:          "https://rpc-mainnet.privado.id",
     ContractAddress: common.HexToAddress("0x3C9acB2205Aa72A05F6D77d708b5Cf85FCa3a896"),
  },
}
verifier, err := auth.NewVerifier(loaders.NewEmbeddedKeyLoader(), resolvers)

    Init Verifier:

      var verificationKeyloader = &loaders.FSKeyLoader{Dir: keyDIR}
  resolver := state.ETHResolver{
     RPCUrl:          <polygon_node_http>,
     ContractAddress: <state_contract_address>,
  }

  resolvers := map[string]pubsignals.StateResolver{
    "polygon:amoy": resolver,
  }
  verifier,err := auth.NewVerifierWithExplicitError(verificationKeyloader, loaders.DefaultSchemaLoader{IpfsURL: "<IPFS NODE HERE>"}, resolvers)
  // or use NewVerifier and check that verifier instance is not nil. IPFS merklization is not worked without setuping global loader
  // verifier := auth.NewVerifier(verificationKeyloader, loaders.DefaultSchemaLoader{IpfsURL: "ipfs.io"}, resolvers)

  4. FullVerify - verify JWZ token generated by the client:

 authResponse, err := verifier.FullVerify(
    r.Context(), 
    string(tokenBytes),
    authRequest.(protocolAuthorizationRequestMessage), 
    ...VerifyOpt,
 )
 userId = authResponse.from // msg sender

Verify manually if thread id is used a session id to match request with VerifyJWZ / VerifyAuthResponse functions

Examples of various supported configurations for different networks

  • Addresses and networks of all supported state contracts can be found in the iden3 documentation
  • For custom implementations and private networks you can deploy you own state contract Contracts repository
  • It is recommended to use you own RPC nodes or third-party services like Infura or Alchemy
const COMMON_STATE_ADDRESS = "0x3C9acB2205Aa72A05F6D77d708b5Cf85FCa3a896" // Common state address. Ethereum, 
// Privado, Linea, zkEVM networks
const POLYGON_MAIN_STATE_ADDRESS = "0x624ce98D2d27b20b8f8d521723Df8fC4db71D79D" // Polygon main state address
const POLYGON_AMOY_STATE_ADDRESS = "0x1a4cC30f2aA0377b0c3bc9848766D90cb4404124" // // Polygon amoy state address

resolvers := map[string]pubsignals.StateResolver{
   // Privado Identity Chain
   "privado:main": state.NewETHResolver("https://rpc-mainnet.privado.id", COMMON_STATE_ADDRESS),
   // Ethereum main
   "ethereum:main": state.NewETHResolver("<RPC URL Ethereum main net>", COMMON_STATE_ADDRESS),
   // Polygon POS main
   "polygon:main": state.NewETHResolver("<RPC URL Polygon main net", POLYGON_MAIN_STATE_ADDRESS),
   // Polygon zkEVM main
   "zkevm:main": state.NewETHResolver("<RPC URL zkEVM main net>", COMMON_STATE_ADDRESS),
   // Linea main
   "linea:main": state.NewETHResolver("<RPC URL Linea main net>", COMMON_STATE_ADDRESS),
   // Ethereum Sepolia
   "ethereum:sepolia": state.NewETHResolver("<RPC URL Etherum seploia>", COMMON_STATE_ADDRESS),
   // Polygon Amoy
   "polygon:amoy": state.NewETHResolver("https://rpc-amoy.polygon.technology/", POLYGON_AMOY_STATE_ADDRESS),
   // Polygon zkEVM Cardona
   "zkevm:test": state.NewETHResolver("<RPC URL Polygon zkEVM net>", COMMON_STATE_ADDRESS),
   // Linea-Sepolia
   "linea:sepolia": state.NewETHResolver("RPC URL Linea sepolia"), COMMON_STATE_ADDRESS),
}

Notes on prover optimization for x86_64 hardware

See readme in iden3/go-rapidsnark/prover

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.

License

© 2023 0kims Association

This project is licensed under either of

at your option.