java.lang.Object
- org.bouncycastle.asn1.ASN1Object
- - org.bouncycastle.asn1.cms.KeyAgreeRecipientInfo

All Implemented Interfaces:: ASN1Encodable, Encodable

public class KeyAgreeRecipientInfo
extends ASN1Object

RFC 5652: Content encryption key delivery mechanisms.

 KeyAgreeRecipientInfo ::= SEQUENCE {
     version CMSVersion,  -- always set to 3
     originator [0] EXPLICIT OriginatorIdentifierOrKey,
     ukm [1] EXPLICIT UserKeyingMaterial OPTIONAL,
     keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
     recipientEncryptedKeys RecipientEncryptedKeys 
 }

 UserKeyingMaterial ::= OCTET STRING

Constructor Summary

Constructors
Constructor	Description
`KeyAgreeRecipientInfo(ASN1Sequence seq)`	Deprecated. use getInstance()
`KeyAgreeRecipientInfo(OriginatorIdentifierOrKey originator, ASN1OctetString ukm, AlgorithmIdentifier keyEncryptionAlgorithm, ASN1Sequence recipientEncryptedKeys)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KeyAgreeRecipientInfo`	`getInstance(java.lang.Object obj)`	Return a KeyAgreeRecipientInfo object from the given object.
`static KeyAgreeRecipientInfo`	`getInstance(ASN1TaggedObject obj, boolean explicit)`	Return a KeyAgreeRecipientInfo object from a tagged object.
`AlgorithmIdentifier`	`getKeyEncryptionAlgorithm()`
`OriginatorIdentifierOrKey`	`getOriginator()`
`ASN1Sequence`	`getRecipientEncryptedKeys()`
`ASN1OctetString`	`getUserKeyingMaterial()`
`ASN1Integer`	`getVersion()`
`ASN1Primitive`	`toASN1Primitive()`	Produce an object suitable for an ASN1OutputStream.

Methods inherited from class org.bouncycastle.asn1.ASN1Object
encodeTo, encodeTo, equals, getEncoded, getEncoded, hasEncodedTagValue, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KeyAgreeRecipientInfo
```
public KeyAgreeRecipientInfo(OriginatorIdentifierOrKey originator,
                             ASN1OctetString ukm,
                             AlgorithmIdentifier keyEncryptionAlgorithm,
                             ASN1Sequence recipientEncryptedKeys)
```
  - KeyAgreeRecipientInfo
```
public KeyAgreeRecipientInfo(ASN1Sequence seq)
```
    Deprecated.
    use getInstance()
- Method Detail
  - getInstance
```
public static KeyAgreeRecipientInfo getInstance(ASN1TaggedObject obj,
                                                boolean explicit)
```
    Return a KeyAgreeRecipientInfo object from a tagged object.
    
    Parameters:
    
    obj - the tagged object holding the object we want.
    
    explicit - true if the object is meant to be explicitly tagged false otherwise.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the object held by the tagged object cannot be converted.
  - getInstance
```
public static KeyAgreeRecipientInfo getInstance(java.lang.Object obj)
```
    Return a KeyAgreeRecipientInfo object from the given object.
    Accepted inputs:
    
    null → null
    KeyAgreeRecipientInfo object
    ASN1Sequence input formats with KeyAgreeRecipientInfo structure inside
    Parameters:
    
    obj - the object we want converted.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the object cannot be converted.
  - getVersion
```
public ASN1Integer getVersion()
```
  - getOriginator
```
public OriginatorIdentifierOrKey getOriginator()
```
  - getUserKeyingMaterial
```
public ASN1OctetString getUserKeyingMaterial()
```
  - getKeyEncryptionAlgorithm
```
public AlgorithmIdentifier getKeyEncryptionAlgorithm()
```
  - getRecipientEncryptedKeys
```
public ASN1Sequence getRecipientEncryptedKeys()
```
  - toASN1Primitive
```
public ASN1Primitive toASN1Primitive()
```
    Produce an object suitable for an ASN1OutputStream.
    
    Specified by:
    
    toASN1Primitive in interface ASN1Encodable
    
    Specified by:
    
    toASN1Primitive in class ASN1Object
    
    Returns:
    
    a primitive representation of this object.

Class KeyAgreeRecipientInfo

Constructor Summary

Method Summary

Methods inherited from class org.bouncycastle.asn1.ASN1Object

Methods inherited from class java.lang.Object

Constructor Detail

KeyAgreeRecipientInfo

KeyAgreeRecipientInfo

Method Detail

getInstance

getInstance

getVersion

getOriginator

getUserKeyingMaterial

getKeyEncryptionAlgorithm

getRecipientEncryptedKeys

toASN1Primitive