Document type <nymData>

Elements and attributes

• Attribute version: String. The container version.
• Attribute nymID: Identifier. The ID of the Nym being described.
• Element nymIDSource: the source passed to the newnym command when the Nym was created, or the generated public key when nothing was passed.
• Element masterCredential: This is the top level key of the set of credentials a Nym has. It is used to validate the signature on the subcredentials.
• Attribute ID: Identifier. The ID of the (sub)credential.
• Attribute valid: Boolean. Whether or not this key is still valid. TODO: who/what determines this?
• Element keyCredential: presumably one of the encryption or signing keys. Can occur more than once.
• Attribute masterID: Identifier. The ID of the master credential.
• Attribute ID: Identifier. The ID of the (sub)credential.
• Attribute valid: Boolean. Whether or not this key is still valid. TODO: who/what determines this?
• Element subCredential: presumably one of the encryption or signing keys. Can occur more than once.
• Attribute masterID: Identifier. The ID of the master credential.
• Attribute ID: Identifier. The ID of the (sub)credential.
• Attribute valid: Boolean. Whether or not this key is still valid. revoked. TODO: who/what determines this?

Example

<nymData version="1.0"
 nymID="voeqDVAJwDwROywFtg5mEyYpcu2dcPJRLFHYh7tyhqk">

  <nymIDSource>
    $nymIDSource (armored)
  </nymIDSource>

  <masterCredential
   ID="UESzvzSw6zqC7BuvlcHmbPKTmf5BIbG0RNvCTpDx1kH"
   valid="true"/>

  <keyCredential
   ID="EvcfMaNJ3fiK4lUVhQNhHmX1Qc3mjlA6q0MS96JXNNO"
   masterID="UESzvzSw6zqC7BuvlcHmbPKTmf5BIbG0RNvCTpDx1kH"
   valid="true"/>

</nymData>

References

• OTPseudonym::OTPseudonym::SavePseudonym
• OTPseudonym::SaveCredentialListToString
• OTPseudonym::GetPublicCredentials
• OTPseudonym::GetPrivateCredentials
• OTCredential::SerializeIDs

Notes

This document type is often embedded in other document types which already include nymIDSource leading to some duplication here. TODO it's unclear how prevalent this is or whether it is necessary to correct this.