protocol/json/keybase1/upk.json - master - githubmirror/client

protocol/json/keybase1/upk.json
441 строка8 KB
Antonio Marcedone
typing DeviceTypes attempt 2 (#22277)
03 фев 2020, 16:33
03 фев 2020, 16:33937e8df
{
  "protocol": "UPK",
  "imports": [
    {
      "path": "common.avdl",
      "type": "idl"
    }
  ],
  "types": [
    {
      "type": "enum",
      "name": "KeyType",
      "symbols": [
        "NONE_0",
        "NACL_1",
        "PGP_2"
      ]
    },
    {
      "type": "enum",
      "name": "UPK2MinorVersion",
      "symbols": [
        "V0_0",
        "V1_1",
        "V2_2",
        "V3_3",
        "V4_4",
        "V5_5",
        "V6_6"
      ]
    },
    {
      "type": "record",
      "name": "MerkleRootV2",
      "fields": [
        {
          "type": "Seqno",
          "name": "seqno"
        },
        {
          "type": "HashMeta",
          "name": "hashMeta"
        }
      ]
    },
    {
      "type": "record",
      "name": "SigChainLocation",
      "fields": [
        {
          "type": "Seqno",
          "name": "seqno"
        },
        {
          "type": "SeqType",
          "name": "seqType"
        }
      ]
    },
    {
      "type": "record",
      "name": "MerkleTreeLocation",
      "fields": [
        {
          "type": "UserOrTeamID",
          "name": "leaf"
        },
        {
          "type": "SigChainLocation",
          "name": "loc"
        }
      ]
    },
    {
      "type": "record",
      "name": "SignatureMetadata",
      "fields": [
        {
          "type": "KID",
          "name": "signingKID"
        },
        {
          "type": "MerkleRootV2",
          "name": "prevMerkleRootSigned"
        },
        {
          "type": "Seqno",
          "name": "firstAppearedUnverified"
        },
        {
          "type": "Time",
          "name": "time"
        },
        {
          "type": "SigChainLocation",
          "name": "sigChainLocation"
        }
      ]
    },
    {
      "type": "record",
      "name": "PublicKeyV2Base",
      "fields": [
        {
          "type": "KID",
          "name": "kid"
        },
        {
          "type": "boolean",
          "name": "isSibkey"
        },
        {
          "type": "boolean",
          "name": "isEldest"
        },
        {
          "type": "Time",
          "name": "cTime"
        },
        {
          "type": "Time",
          "name": "eTime"
        },
        {
          "type": "SignatureMetadata",
          "name": "provisioning"
        },
        {
          "type": [
            null,
            "SignatureMetadata"
          ],
          "name": "revocation"
        }
      ]
    },
    {
      "type": "record",
      "name": "PublicKeyV2NaCl",
      "fields": [
        {
          "type": "PublicKeyV2Base",
          "name": "base"
        },
        {
          "type": [
            null,
            "KID"
          ],
          "name": "parent"
        },
        {
          "type": "DeviceID",
          "name": "deviceID"
        },
        {
          "type": "string",
          "name": "deviceDescription"
        },
        {
          "type": "DeviceTypeV2",
          "name": "deviceType"
        }
      ]
    },
    {
      "type": "fixed",
      "name": "PGPFingerprint",
      "size": "20"
    },
    {
      "type": "record",
      "name": "PublicKeyV2PGPSummary",
      "fields": [
        {
          "type": "PublicKeyV2Base",
          "name": "base"
        },
        {
          "type": "PGPFingerprint",
          "name": "fingerprint"
        },
        {
          "type": {
            "type": "array",
            "items": "PGPIdentity"
          },
          "name": "identities"
        }
      ]
    },
    {
      "type": "variant",
      "name": "PublicKeyV2",
      "switch": {
        "type": "KeyType",
        "name": "keyType"
      },
      "cases": [
        {
          "label": {
            "name": "NACL",
            "def": false
          },
          "body": "PublicKeyV2NaCl"
        },
        {
          "label": {
            "name": "PGP",
            "def": false
          },
          "body": "PublicKeyV2PGPSummary"
        },
        {
          "label": {
            "def": true
          },
          "body": null
        }
      ]
    },
    {
      "type": "record",
      "name": "UserPlusKeysV2",
      "fields": [
        {
          "type": "UID",
          "name": "uid"
        },
        {
          "type": "string",
          "name": "username"
        },
        {
          "type": "Seqno",
          "name": "eldestSeqno"
        },
        {
          "type": "StatusCode",
          "name": "status"
        },
        {
          "type": {
            "type": "array",
            "items": "PerUserKey"
          },
          "name": "perUserKeys"
        },
        {
          "type": {
            "type": "map",
            "values": "PublicKeyV2NaCl",
            "keys": "KID"
          },
          "name": "deviceKeys"
        },
        {
          "type": {
            "type": "map",
            "values": "PublicKeyV2PGPSummary",
            "keys": "KID"
          },
          "name": "pgpKeys"
        },
        {
          "type": [
            null,
            "string"
          ],
          "name": "stellarAccountID"
        },
        {
          "type": {
            "type": "map",
            "values": "RemoteTrack",
            "keys": "UID"
          },
          "name": "remoteTracks"
        },
        {
          "type": [
            null,
            "ResetSummary"
          ],
          "name": "reset"
        },
        {
          "type": "boolean",
          "name": "unstubbed"
        }
      ]
    },
    {
      "type": "record",
      "name": "UserPlusKeysV2AllIncarnations",
      "fields": [
        {
          "type": "UserPlusKeysV2",
          "name": "current"
        },
        {
          "type": {
            "type": "array",
            "items": "UserPlusKeysV2"
          },
          "name": "pastIncarnations"
        },
        {
          "type": "UserVersionVector",
          "name": "uvv"
        },
        {
          "type": {
            "type": "map",
            "values": "LinkID",
            "keys": "Seqno"
          },
          "name": "seqnoLinkIDs"
        },
        {
          "type": "UPK2MinorVersion",
          "name": "minorVersion"
        },
        {
          "type": "boolean",
          "name": "stale"
        }
      ]
    },
    {
      "type": "enum",
      "name": "UPAKVersion",
      "symbols": [
        "V1_1",
        "V2_2"
      ]
    },
    {
      "type": "variant",
      "name": "UPAKVersioned",
      "switch": {
        "type": "UPAKVersion",
        "name": "v"
      },
      "cases": [
        {
          "label": {
            "name": "V1",
            "def": false
          },
          "body": "UserPlusAllKeys"
        },
        {
          "label": {
            "name": "V2",
            "def": false
          },
          "body": "UserPlusKeysV2AllIncarnations"
        }
      ],
      "doc": "* What we're storing for each user. At first it was UPAKs, as defined\n   * in common.avdl. But going forward, we're going to use UserPlusKeysV2AllIncarnations."
    },
    {
      "type": "enum",
      "name": "UPKLiteMinorVersion",
      "symbols": [
        "V0_0"
      ]
    },
    {
      "type": "record",
      "name": "UPKLiteV1",
      "fields": [
        {
          "type": "UID",
          "name": "uid"
        },
        {
          "type": "string",
          "name": "username"
        },
        {
          "type": "Seqno",
          "name": "eldestSeqno"
        },
        {
          "type": "StatusCode",
          "name": "status"
        },
        {
          "type": {
            "type": "map",
            "values": "PublicKeyV2NaCl",
            "keys": "KID"
          },
          "name": "deviceKeys"
        },
        {
          "type": [
            null,
            "ResetSummary"
          ],
          "name": "reset"
        }
      ],
      "lint": "ignore"
    },
    {
      "type": "record",
      "name": "UPKLiteV1AllIncarnations",
      "fields": [
        {
          "type": "UPKLiteV1",
          "name": "current"
        },
        {
          "type": {
            "type": "array",
            "items": "UPKLiteV1"
          },
          "name": "pastIncarnations"
        },
        {
          "type": {
            "type": "map",
            "values": "LinkID",
            "keys": "Seqno"
          },
          "name": "seqnoLinkIDs"
        },
        {
          "type": "UPKLiteMinorVersion",
          "name": "minorVersion"
        }
      ],
      "lint": "ignore"
    }
  ],
  "messages": {},
  "namespace": "keybase.1"
}