using System; using System.Collections.Generic; using System.IO; using Org.BouncyCastle.Utilities.Collections; namespace Org.BouncyCastle.Bcpg.OpenPgp { /// /// Class to hold a single master public key and its subkeys. ///

/// Often PGP keyring files consist of multiple master keys, if you are trying to process /// or construct one of these you should use the PgpPublicKeyRingBundle class. ///

///
public class PgpPublicKeyRing : PgpKeyRing { private readonly IList keys; public PgpPublicKeyRing( byte[] encoding) : this(new MemoryStream(encoding, false)) { } internal PgpPublicKeyRing(IList pubKeys) { this.keys = pubKeys; } public PgpPublicKeyRing( Stream inputStream) { this.keys = new List(); BcpgInputStream bcpgInput = BcpgInputStream.Wrap(inputStream); PacketTag initialTag = bcpgInput.SkipMarkerPackets(); if (initialTag != PacketTag.PublicKey && initialTag != PacketTag.PublicSubkey) { throw new IOException("public key ring doesn't start with public key tag: " + "tag 0x" + ((int)initialTag).ToString("X")); } PublicKeyPacket pubPk = ReadPublicKeyPacket(bcpgInput); TrustPacket trustPk = ReadOptionalTrustPacket(bcpgInput); // direct signatures and revocations var keySigs = ReadSignaturesAndTrust(bcpgInput); ReadUserIDs(bcpgInput, out var ids, out var idTrusts, out var idSigs); keys.Add(new PgpPublicKey(pubPk, trustPk, keySigs, ids, idTrusts, idSigs)); // Read subkeys while (bcpgInput.NextPacketTag() == PacketTag.PublicSubkey) { keys.Add(ReadSubkey(bcpgInput)); } } /// Return the first public key in the ring. public virtual PgpPublicKey GetPublicKey() { return keys[0]; } /// Return the public key referred to by the passed in key ID if it is present. public virtual PgpPublicKey GetPublicKey(long keyId) { foreach (PgpPublicKey k in keys) { if (keyId == k.KeyId) return k; } return null; } /// Return the public key with the passed in fingerprint if it is present. public virtual PgpPublicKey GetPublicKey(byte[] fingerprint) { foreach (PgpPublicKey k in keys) { if (k.HasFingerprint(fingerprint)) return k; } return null; } /// Allows enumeration of all the public keys. /// An IEnumerable of PgpPublicKey objects. public virtual IEnumerable GetPublicKeys() { return CollectionUtilities.Proxy(keys); } public virtual byte[] GetEncoded() { MemoryStream bOut = new MemoryStream(); Encode(bOut); return bOut.ToArray(); } public virtual void Encode( Stream outStr) { if (outStr == null) throw new ArgumentNullException("outStr"); foreach (PgpPublicKey k in keys) { k.Encode(outStr); } } /// /// Returns a new key ring with the public key passed in either added or /// replacing an existing one. /// /// The public key ring to be modified. /// The public key to be inserted. /// A new PgpPublicKeyRing public static PgpPublicKeyRing InsertPublicKey( PgpPublicKeyRing pubRing, PgpPublicKey pubKey) { var keys = new List(pubRing.keys); bool found = false; bool masterFound = false; for (int i = 0; i != keys.Count; i++) { PgpPublicKey key = keys[i]; if (key.KeyId == pubKey.KeyId) { found = true; keys[i] = pubKey; } if (key.IsMasterKey) { masterFound = true; } } if (!found) { if (pubKey.IsMasterKey) { if (masterFound) throw new ArgumentException("cannot add a master key to a ring that already has one"); keys.Insert(0, pubKey); } else { keys.Add(pubKey); } } return new PgpPublicKeyRing(keys); } /// Returns a new key ring with the public key passed in removed from the key ring. /// The public key ring to be modified. /// The public key to be removed. /// A new PgpPublicKeyRing, or null if pubKey is not found. public static PgpPublicKeyRing RemovePublicKey(PgpPublicKeyRing pubRing, PgpPublicKey pubKey) { int count = pubRing.keys.Count; long keyID = pubKey.KeyId; var result = new List(count); bool found = false; foreach (var key in pubRing.keys) { if (key.KeyId == keyID) { found = true; continue; } result.Add(key); } return found ? new PgpPublicKeyRing(result) : null; } internal static PublicKeyPacket ReadPublicKeyPacket(BcpgInputStream bcpgInput) { Packet packet = bcpgInput.ReadPacket(); if (!(packet is PublicKeyPacket publicKeyPacket)) throw new IOException("unexpected packet in stream: " + packet); return publicKeyPacket; } internal static PgpPublicKey ReadSubkey(BcpgInputStream bcpgInput) { PublicKeyPacket pk = ReadPublicKeyPacket(bcpgInput); TrustPacket kTrust = ReadOptionalTrustPacket(bcpgInput); // PGP 8 actually leaves out the signature. var sigList = ReadSignaturesAndTrust(bcpgInput); return new PgpPublicKey(pk, kTrust, sigList); } /** * Join two copies of the same certificate. * The certificates must have the same primary key, but may carry different subkeys, user-ids and signatures. * The resulting certificate will carry the sum of both certificates subkeys, user-ids and signatures. *
* This method will ignore trust packets on the second copy of the certificate and instead * copy the local certificate's trust packets to the joined certificate. * * @param first local copy of the certificate * @param second remote copy of the certificate (e.g. from a key server) * @return joined key ring * @throws PGPException */ public static PgpPublicKeyRing Join(PgpPublicKeyRing first, PgpPublicKeyRing second) { return Join(first, second, false, false); } /** * Join two copies of the same certificate. * The certificates must have the same primary key, but may carry different subkeys, user-ids and signatures. * The resulting certificate will carry the sum of both certificates subkeys, user-ids and signatures. *
* For each subkey holds: If joinTrustPackets is set to true and the second key is carrying a trust packet, * the trust packet will be copied to the joined key. * Otherwise, the joined key will carry the trust packet of the local copy. * * @param first local copy of the certificate * @param second remote copy of the certificate (e.g. from a key server) * @param joinTrustPackets if true, trust packets from the second certificate copy will be carried over into the joined certificate * @param allowSubkeySigsOnNonSubkey if true, the resulting joined certificate may carry subkey signatures on its primary key * @return joined certificate * @throws PGPException */ public static PgpPublicKeyRing Join(PgpPublicKeyRing first, PgpPublicKeyRing second, bool joinTrustPackets, bool allowSubkeySigsOnNonSubkey) { if (!second.GetPublicKey().HasFingerprint(first.GetPublicKey().GetFingerprint())) throw new ArgumentException("Cannot merge certificates with differing primary keys."); var secondKeys = new HashSet(); foreach (var key in second.keys) { secondKeys.Add(key.KeyId); } var merged = new List(); foreach (var key in first.keys) { var copy = second.GetPublicKey(key.KeyId); if (copy != null) { merged.Add(PgpPublicKey.Join(key, copy, joinTrustPackets, allowSubkeySigsOnNonSubkey)); secondKeys.Remove(key.KeyId); } else { merged.Add(key); } } foreach (var additionalKeyId in secondKeys) { merged.Add(second.GetPublicKey(additionalKeyId)); } return new PgpPublicKeyRing(merged); } } }