Skip to main content

Using enhanced permissioning

Managing the enhanced permissioning model can be broadly categorized into the following activities:

Setting up the initial network​

Please refer to the configuration instructions for detailed information. For an existing network running with an older version of GoQuorum:

  1. Upgrade GoQuorum to the latest version.
  2. Deploy the contracts.
  3. Execute the init method of PermissionsUpgradable.sol from the guardian account.
  4. Copy the permission-config.json to the data directory of each node.
  5. Bring geth up in --permissioned mode.

For a new network using the latest version of GoQuorum:

  1. Bring up the initial set of nodes.
  2. Deploy the contracts.
  3. Execute the init method of PermissionsUpgradable.sol from the guardian account.
  4. Upgrade GoQuorum to the latest version.
  5. Copy the permission-config.json to the data directory of each node.
  6. Bring geth up in --permissioned mode.

As part of network initialization:

  • A network admin organization is created with the nwAdminOrg name specified in permission-config.json. All nodes which are part of static-nodes.json are assigned to this organization.
  • A network admin role is created with the nwAdminRole name specified in the config file.
  • All accounts given in the accounts array of the config file are assigned the network admin role. These accounts will have the ability to propose and approve new organizations into the network.

Example​

This example assumes that the network was started with the permission-config.json given in the configuration instructions, and that the network was brought up with the static-nodes.json file as the following:

[
  "enode://72c0572f7a2492cffb5efc3463ef350c68a0446402a123dacec9db5c378789205b525b3f5f623f7548379ab0e5957110bffcf43a6115e450890f97a9f65a681a@127.0.0.1:21000?discport=0",
  "enode://7a1e3b5c6ad614086a4e5fb55b6fe0a7cf7a7ac92ac3a60e6033de29df14148e7a6a7b4461eb70639df9aa379bd77487937bea0a8da862142b12d326c7285742@127.0.0.1:21001?discport=0",
  "enode://5085e86db5324ca4a55aeccfbb35befb412def36e6bc74f166102796ac3c8af3cc83a5dec9c32e6fd6d359b779dba9a911da8f3e722cb11eb4e10694c59fd4a1@127.0.0.1:21002?discport=0",
  "enode://28a4afcf56ee5e435c65b9581fc36896cc684695fa1db83c9568de4353dc6664b5cab09694d9427e9cf26a5cd2ac2fb45a63b43bb24e46ee121f21beb3a7865e@127.0.0.1:21003?discport=0"
]

View the organization list with the following command:

quorumPermission.orgList;

View ADMINORG's details:

quorumPermission.getOrgDetails("ADMINORG");

Proposing a new organization into the network​

Once the network is up, the network admin accounts can then propose a new organization into the network.

Majority approval from the network admin accounts is required before an organization is approved.

The APIs for proposing and approving an organization are documented in permission APIs.

Example​

This example is to propose and approve an organization by name ORG1.

Propose to add ORG1 with the following command:

quorumPermission.addOrg(
  "ORG1",
  "enode://de9c2d5937e599930832cecc1df8cc90b50839bdf635c1a4e68e1dab2d001cd4a11c626e155078cc65958a72e2d72c1342a28909775edd99cc39470172cce0ac@127.0.0.1:21004?discport=0",
  "0x0638e1574728b6d862dd5d3a3e0942c3be47d996",
  { from: "0xed9d02e382b34818e88b88a309c7fe71e65f419d" },
);

Once the organization is proposed, it will be in Proposed state awaiting approval from other network admin accounts.

View ORG1's status:

quorumPermission.orgList[1];

The network admin accounts can then approve the proposed organizations with the following command, and once the majority approval is achieved, the organization status is updated to Approved:

quorumPermission.approveOrg(
  "ORG1",
  "enode://de9c2d5937e599930832cecc1df8cc90b50839bdf635c1a4e68e1dab2d001cd4a11c626e155078cc65958a72e2d72c1342a28909775edd99cc39470172cce0ac@127.0.0.1:21004?discport=0",
  "0x0638e1574728b6d862dd5d3a3e0942c3be47d996",
  { from: "0xca843569e3427144cead5e4d5999a3d0ccf92b8e" },
);

See that ORG1's status was updated in the organization list with the following command:

quorumPermission.orgList[1];

View the details of the new approved organization:

quorumPermission.getOrgDetails("ORG1");

At this point:

  • An organization admin role with name as given in orgAdminRole in permission-config.json has been created and linked to the ORG1.

  • The account 0x0638e1574728b6d862dd5d3a3e0942c3be47d996 has been linked to ORG1 and the organization admin role. This account acts as the organization admin account and can manage further roles, nodes, and accounts at the organization level.

  • The node has been linked to the organization and its status has been updated as Approved.

The new node belonging to the organization can now join the network. In case the network is running in Raft consensus mode, before the node joins the network, ensure that:

  • The node has been added as a peer using raft.addPeer(<<enodeId>>).

  • You bring up geth for the new node using --raftjoinexisting with the peer ID as obtained in the previous step.

Managing the organization-level permissions​

Once the organization is approved and the node of the organization has joined the network, the organization admin can:

  • Create sub-organizations, add roles, and add additional nodes at organization level.

  • Add accounts to the organization.

  • Change roles of existing organization-level accounts.

Use quorumPermission_addSubOrg to add a sub-organization at the ORG1 level.

Example​

Add a sub-organization with the following command:

quorumPermission.addSubOrg(
  "ORG1",
  "SUB1",
  "enode://239c1f044a2b03b6c4713109af036b775c5418fe4ca63b04b1ce00124af00ddab7cc088fc46020cdc783b6207efe624551be4c06a994993d8d70f684688fb7cf@127.0.0.1:21006?discport=0",
  { from: eth.accounts[0] },
);

Get the sub-organization's details:

quorumPermission.getOrgDetails("ORG1.SUB1");

The enode ID is not mandatory for adding a sub-organization.

If the organization admin wants to add an admin account for the newly created sub-organization, the organization admin account must first create a role using quorumPermission_addNewRole with isAdminRole set to true, then assign this role to the account which belongs to the sub-organization.

Once assigned, the account will act as organization admin at the sub-organization level.

Add a new admin account for the sub-organization with the following command:

quorumPermission.addNewRole("ORG1.SUB1", "SUBADMIN", 3, false, true, {
  from: eth.accounts[0],
});

View the organization admin account ID:

eth.accounts[0];

The sub-organization admin role SUBADMIN can now be assigned to an account at SUB1.

Add the account as a SUBADMIN to SUB1 with the following command:

quorumPermission.addAccountToOrg(
  "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0",
  "ORG1.SUB1",
  "SUBADMIN",
  { from: "0x0638e1574728b6d862dd5d3a3e0942c3be47d996" },
);

View SUB1's details:

quorumPermission.getOrgDetails("ORG1.SUB1");

The account 0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0 is now the admin for SUB1 and can add roles, accounts, and nodes to the sub-organization.

Add a new role TRANSACT to SUB1 with the following command:

quorumPermission.addNewRole("ORG1.SUB1", "TRANSACT", 1, false, true, {
  from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0",
});

View SUB1's role list:

quorumPermission.getOrgDetails("ORG1.SUB1").roleList;
note

The organization admin account at the master organization level has the admin rights on all the children sub-organizations. However, the admin account at the sub-organization level has control only in its sub-organization.

To add an account to an organization, use quorumPermission_addAccountToOrg:

quorumPermission.addAccountToOrg(
  "0x283f3b8989ec20df621166973c93b56b0f4b5455",
  "ORG1.SUB1",
  "SUBADMIN",
  { from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0" },
);

View the organization's account list:

quorumPermission.getOrgDetails("ORG1.SUB1").acctList;

To suspend an account, use quorumPermission_updateAccountStatus with action set to 1:

quorumPermission.updateAccountStatus(
  "ORG1.SUB1",
  "0x283f3b8989ec20df621166973c93b56b0f4b5455",
  1,
  { from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0" },
);

View the account's updated status in the organization's account list:

quorumPermission.getOrgDetails("ORG1.SUB1").acctList;

To revoke suspension of an account, use quorumPermission_updateAccountStatus with action set to 2:

quorumPermission.updateAccountStatus(
  "ORG1.SUB1",
  "0x283f3b8989ec20df621166973c93b56b0f4b5455",
  2,
  { from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0" },
);

View the account's updated status in the organization's account list:

quorumPermission.getOrgDetails("ORG1.SUB1").acctList;

To exclude an account, use quorumPermission_updateAccountStatus with action set to 3:

quorumPermission.updateAccountStatus(
  "ORG1.SUB1",
  "0x283f3b8989ec20df621166973c93b56b0f4b5455",
  3,
  { from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0" },
);

Once excluded, no further activity is possible on the account. View the account's updated status in the organization's account list:

quorumPermission.getOrgDetails("ORG1.SUB1").acctList;

To add nodes at the organization and sub-organization level, use quorumPermission_addNode:

quorumPermission.addNode(
  "ORG1.SUB1",
  "enode://eacaa74c4b0e7a9e12d2fe5fee6595eda841d6d992c35dbbcc50fcee4aa86dfbbdeff7dc7e72c2305d5a62257f82737a8cffc80474c15c611c037f52db1a3a7b@127.0.0.1:21005?discport=0",
  { from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0" },
);

View the organization's updated node list:

quorumPermission.getOrgDetails("ORG1.SUB1").nodeList;

To manage the status of the nodes, use quorumPermission_updateNodeStatus. To deactivate a node, call the method with action set to 1:

quorumPermission.getOrgDetails("ORG1.SUB1").nodeList;

To re-activate a node, use quorumPermission_updateNodeStatus with action set to 2:

quorumPermission.updateNodeStatus(
  "ORG1.SUB1",
  "enode://eacaa74c4b0e7a9e12d2fe5fee6595eda841d6d992c35dbbcc50fcee4aa86dfbbdeff7dc7e72c2305d5a62257f82737a8cffc80474c15c611c037f52db1a3a7b@127.0.0.1:21005?discport=0",
  2,
  { from: "0x42ef6abedcb7ecd3e9c4816cd5f5a96df35bb9a0" },
);

View the node's updated status in the organization's node list:

quorumPermission.getOrgDetails("ORG1.SUB1").nodeList;

To exclude a node, use quorumPermission_updateNodeStatus with action set to 3:

quorumPermission.getOrgDetails("ORG1.SUB1").nodeList;

Once excluded, a node can't re-join a network.

note
  • In Raft consensus, when a node is deactivated, the peer ID is lost. Upon activation, the node needs to be added to the Raft cluster again using raft.addPeer and the node should be brought up with a new peer ID.
  • An account can transact from any of the nodes within the same organization.
  • No transaction is allowed from a deactivated node.

Suspending an organization temporarily​

If you need to temporarily suspend all activities of an organization, use quorumPermission_updateOrgStatus with action set to 1. This can be invoked only by network admin accounts and requires majority approval.

Example​

Suspend ORG1 with the following command:

quorumPermission.updateOrgStatus("ORG1", 1, {
  from: "0xed9d02e382b34818e88b88a309c7fe71e65f419d",
});

View the organization's updated status in the organization list:

quorumPermission.orgList[2];

Suspending an organization requires majority approval from other network admin accounts, using quorumPermission_approveOrgStatus. Once approved the organization status is marked as Suspended.

quorumPermission.approveOrgStatus("ORG1", 1, {
  from: "0xca843569e3427144cead5e4d5999a3d0ccf92b8e",
});

View the organization's updated status in the organization list:

quorumPermission.orgList[2];

When the organization is suspended, no transaction from any of the accounts linked to the organization or sub-organizations under it is allowed. However, the nodes linked to the organization are active and are syncing with the network.

Revoking suspension of an organization​

To revoke the suspension of an organization, use quorumPermission_updateOrgStatus with action set to 2.

Example​

Revoke the suspension of ORG1 with the following command:

quorumPermission.updateOrgStatus("ORG1", 2, {
  from: "0xed9d02e382b34818e88b88a309c7fe71e65f419d",
});

Revoking an organization's suspension requires majority approval using quorumPermission_approveOrgStatus with action set to 2:

quorumPermission.approveOrgStatus("ORG1", 2, {
  from: "0xed9d02e382b34818e88b88a309c7fe71e65f419d",
});

View the organization's updated status in the organization list:

quorumPermission.orgList[0];

Once the revoke is approved, all accounts in the organization and sub-organizations under it are able to transact as per role level access.

Assigning admin privileges at organization and network level​

At times, an account at the organization level may need be able to perform network admin activities. Also, there may be a need to change the admin account at organization level.

Both of these activities can be performed by existing network admin accounts only, and will require majority approval from the network admin accounts.

Example​

To assign a network admin or organization admin role to an account, use quorumPermission_assignAdminRole:

quorumPermission.assignAdminRole(
  "ORG1",
  "0x0638e1574728b6d862dd5d3a3e0942c3be47d996",
  "ADMIN",
  { from: "0xed9d02e382b34818e88b88a309c7fe71e65f419d" },
);

View the account's updated role in the account list:

quorumPermission.acctList[3];

View the account's updated status in the account list:

quorumPermission.acctList[4];

The account can now perform all activities allowable by a network admin account and can participate in the approval process for any actions at network level.