Class Group

java.lang.Object

org.bouncycastle.mls.protocol.Group

public class Group
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Group.CommitOptions
static class	Group.CommitParameters
static class	Group.EpochRef
static class	Group.GroupWithMessage
static class	Group.LeafNodeOptions
static class	Group.MessageOptions
class	Group.Tombstone
class	Group.TombstoneWithMessage

Field Summary

Fields

Modifier and Type	Field	Description
static final short	EXTERNAL_COMMIT_PARAMS
static final short	NORMAL_COMMIT_PARAMS
static final short	REINIT_COMMIT_PARAMS
static final short	RESTART_COMMIT_PARAMS

Constructor Summary

Constructors

Constructor	Description
Group()
Group(byte[] initSk, org.bouncycastle.crypto.AsymmetricCipherKeyPair leafSk, byte[] sigSk, KeyPackage keyPackage, Welcome welcome, TreeKEMPublicKey treeIn, Map<Secret,byte[]> externalPsks, Map<Group.EpochRef, byte[]> resumptionPsks)
Group(byte[] groupID, MlsCipherSuite suite, org.bouncycastle.crypto.AsymmetricCipherKeyPair encSk, byte[] sigSk, LeafNode leafNode, List<Extension> extensions)
Group(org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk, GroupInfo groupInfo, TreeKEMPublicKey tree)

Method Summary

Modifier and Type	Method	Description
MLSMessage	add(KeyPackage keyPackage, Group.MessageOptions msgOptions)
Group.GroupWithMessage	commit(Secret leafSecret, Group.CommitOptions commitOptions, Group.MessageOptions msgOptions, Group.CommitParameters params)
Group.GroupWithMessage	createBranch(byte[] groupID, org.bouncycastle.crypto.AsymmetricCipherKeyPair encryptionKeyPair, org.bouncycastle.crypto.AsymmetricCipherKeyPair signatureKeyPair, LeafNode leafNode, List<Extension> extList, List<KeyPackage> keyPackages, byte[] leafSecret, Group.CommitOptions commitOptions)
static Group.GroupWithMessage	externalJoin(Secret leafSecret, org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk, KeyPackage keyPackage, GroupInfo groupInfo, TreeKEMPublicKey tree, Group.MessageOptions msgOptions, LeafIndex removePrior, Map<Secret,byte[]> psks)
long	getEpoch()
byte[]	getEpochAuthenticator()
List<Extension>	getExtensions()
byte[]	getGroupID()
MLSMessage	getGroupInfo(boolean inlineTree)
LeafIndex	getIndex()
KeyScheduleEpoch	getKeySchedule()
MlsCipherSuite	getSuite()
TreeKEMPublicKey	getTree()
MLSMessage	groupContextExtensions(List<Extension> extensions, Group.MessageOptions msgOptions)
Group	handle(byte[] mlsMessageBytes, Group cachedGroup)
Group	handle(byte[] mlsMessageBytes, Group cachedGroup, Group.CommitParameters expectedParams)
Group	handle(AuthenticatedContent auth, Group cachedGroup, Group.CommitParameters expectedParams)
Group	handleBranch(org.bouncycastle.crypto.AsymmetricCipherKeyPair initSk, org.bouncycastle.crypto.AsymmetricCipherKeyPair encSk, org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk, KeyPackage keyPackage, MLSMessage welcome, TreeKEMPublicKey tree)
Group.Tombstone	handleReinitCommit(MLSMessage commitMessage)
void	insertExternalPsk(Secret pskID, byte[] pskSecret)
static MLSMessage	newMemberAdd(byte[] groupID, long epoch, KeyPackage newMember, org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk)
MLSMessage	preSharedKey(byte[] groupID, long epoch, Group.MessageOptions msgOptions)
MLSMessage	preSharedKey(byte[] externalPskId, Group.MessageOptions msgOptions)
MLSMessage	protect(byte[] applicationData, byte[] pt, int paddingSize)
MLSMessage	reinit(byte[] groupID, ProtocolVersion version, MlsCipherSuite suite, List<Extension> extList, Group.MessageOptions msgOptions)
Group.TombstoneWithMessage	reinitCommit(byte[] leafSecret, Group.CommitOptions commitOptions, Group.MessageOptions messageOptions)
MLSMessage	remove(LeafIndex removeIndex, Group.MessageOptions msgOptions)
byte[][]	unprotect(MLSMessage ct)
MLSMessage	update(Proposal update, Group.MessageOptions msgOptions)
Proposal	updateProposal(org.bouncycastle.crypto.AsymmetricCipherKeyPair leafSk, Group.LeafNodeOptions leafOptions)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NORMAL_COMMIT_PARAMS

public static final short NORMAL_COMMIT_PARAMS

See Also:

• Constant Field Values

EXTERNAL_COMMIT_PARAMS

public static final short EXTERNAL_COMMIT_PARAMS

See Also:

• Constant Field Values

RESTART_COMMIT_PARAMS

public static final short RESTART_COMMIT_PARAMS

See Also:

• Constant Field Values

REINIT_COMMIT_PARAMS

public static final short REINIT_COMMIT_PARAMS

See Also:

• Constant Field Values

Constructor Details

Group

public Group()

Group

public Group(org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk,
 GroupInfo groupInfo,
 TreeKEMPublicKey tree)
      throws Exception

Throws:

Exception

Group

public Group(byte[] groupID,
 MlsCipherSuite suite,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair encSk,
 byte[] sigSk,
 LeafNode leafNode,
 List<Extension> extensions)
      throws Exception

Throws:

Exception

Group

public Group(byte[] initSk,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair leafSk,
 byte[] sigSk,
 KeyPackage keyPackage,
 Welcome welcome,
 TreeKEMPublicKey treeIn,
 Map<Secret,byte[]> externalPsks,
 Map<Group.EpochRef, byte[]> resumptionPsks)
      throws Exception

Parameters:

initSk - HPKE private key

leafSk - HPKE private key for leaf node

sigSk - signature private key

keyPackage - key package

welcome - welcome

treeIn - public kem tree (optional)

externalPsks - map of external psks

resumptionPsks - map of resumptions psks

Throws:

Exception

Method Details

insertExternalPsk

public void insertExternalPsk(Secret pskID,
 byte[] pskSecret)

getSuite

public MlsCipherSuite getSuite()

getExtensions

public List<Extension> getExtensions()

getKeySchedule

public KeyScheduleEpoch getKeySchedule()

getTree

public TreeKEMPublicKey getTree()

getEpoch

public long getEpoch()

getGroupID

public byte[] getGroupID()

getIndex

public LeafIndex getIndex()

getGroupInfo

public MLSMessage getGroupInfo(boolean inlineTree)
                        throws Exception

Throws:

Exception

handle

public Group handle(byte[] mlsMessageBytes,
 Group cachedGroup)
             throws Exception

Throws:

Exception

handle

public Group handle(byte[] mlsMessageBytes,
 Group cachedGroup,
 Group.CommitParameters expectedParams)
             throws Exception

Throws:

Exception

handle

public Group handle(AuthenticatedContent auth,
 Group cachedGroup,
 Group.CommitParameters expectedParams)
             throws Exception

Throws:

Exception

createBranch

public Group.GroupWithMessage createBranch(byte[] groupID,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair encryptionKeyPair,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair signatureKeyPair,
 LeafNode leafNode,
 List<Extension> extList,
 List<KeyPackage> keyPackages,
 byte[] leafSecret,
 Group.CommitOptions commitOptions)
                                    throws Exception

Throws:

Exception

handleBranch

public Group handleBranch(org.bouncycastle.crypto.AsymmetricCipherKeyPair initSk,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair encSk,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk,
 KeyPackage keyPackage,
 MLSMessage welcome,
 TreeKEMPublicKey tree)
                   throws Exception

Throws:

Exception

handleReinitCommit

public Group.Tombstone handleReinitCommit(MLSMessage commitMessage)
                                   throws Exception

Throws:

Exception

externalJoin

public static Group.GroupWithMessage externalJoin(Secret leafSecret,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk,
 KeyPackage keyPackage,
 GroupInfo groupInfo,
 TreeKEMPublicKey tree,
 Group.MessageOptions msgOptions,
 LeafIndex removePrior,
 Map<Secret,byte[]> psks)
                                           throws Exception

Throws:

Exception

commit

public Group.GroupWithMessage commit(Secret leafSecret,
 Group.CommitOptions commitOptions,
 Group.MessageOptions msgOptions,
 Group.CommitParameters params)
                              throws Exception

Throws:

Exception

reinitCommit

public Group.TombstoneWithMessage reinitCommit(byte[] leafSecret,
 Group.CommitOptions commitOptions,
 Group.MessageOptions messageOptions)
                                        throws Exception

Throws:

Exception

newMemberAdd

public static MLSMessage newMemberAdd(byte[] groupID,
 long epoch,
 KeyPackage newMember,
 org.bouncycastle.crypto.AsymmetricCipherKeyPair sigSk)
                               throws Exception

Throws:

Exception

protect

public MLSMessage protect(byte[] applicationData,
 byte[] pt,
 int paddingSize)
                   throws Exception

Throws:

Exception

unprotect

public byte[][] unprotect(MLSMessage ct)
                   throws Exception

Throws:

Exception

add

public MLSMessage add(KeyPackage keyPackage,
 Group.MessageOptions msgOptions)
               throws Exception

Throws:

Exception

update

public MLSMessage update(Proposal update,
 Group.MessageOptions msgOptions)
                  throws Exception

Throws:

Exception

groupContextExtensions

public MLSMessage groupContextExtensions(List<Extension> extensions,
 Group.MessageOptions msgOptions)
                                  throws Exception

Throws:

Exception

remove

public MLSMessage remove(LeafIndex removeIndex,
 Group.MessageOptions msgOptions)
                  throws Exception

Throws:

Exception

reinit

public MLSMessage reinit(byte[] groupID,
 ProtocolVersion version,
 MlsCipherSuite suite,
 List<Extension> extList,
 Group.MessageOptions msgOptions)
                  throws Exception

Throws:

Exception

preSharedKey

public MLSMessage preSharedKey(byte[] externalPskId,
 Group.MessageOptions msgOptions)
                        throws Exception

Throws:

Exception

preSharedKey

public MLSMessage preSharedKey(byte[] groupID,
 long epoch,
 Group.MessageOptions msgOptions)
                        throws Exception

Throws:

Exception

updateProposal

public Proposal updateProposal(org.bouncycastle.crypto.AsymmetricCipherKeyPair leafSk,
 Group.LeafNodeOptions leafOptions)
                        throws Exception

Throws:

Exception

getEpochAuthenticator

public byte[] getEpochAuthenticator()