Class: openpgp_packet_encryptedsessionkey

openpgp_packet_encryptedsessionkey

Public-Key Encrypted Session Key Packets (Tag 1) RFC4880 5.1: A Public-Key Encrypted Session Key packet holds the session key used to encrypt a message. Zero or more Public-Key Encrypted Session Key packets and/or Symmetric-Key Encrypted Session Key packets may precede a Symmetrically Encrypted Data Packet, which holds an encrypted message. The message is encrypted with the session key, and the session key is itself encrypted and stored in the Encrypted Session Key packet(s). The Symmetrically Encrypted Data Packet is preceded by one Public-Key Encrypted Session Key packet for each OpenPGP key to which the message is encrypted. The recipient of the message finds a session key that is encrypted to their public key, decrypts the session key, and then uses the session key to decrypt the message.

new openpgp_packet_encryptedsessionkey

Source:
  • openpgp.js, line 1542

Methods

<inner> decrypt

Decrypts the session key (only for public key encrypted session key packets (tag 1)
Parameters:
Name Type Description
msg openpgp_msg_message the message object (with member encryptedData
key openpgp_msg_privatekey private key with secMPIs unlocked
Source:
  • openpgp.js, line 1673
Returns:
the unencrypted session key
Type
String

<inner> read_pub_key_packet

parsing function for a publickey encrypted session key packet (tag 1).
Parameters:
Name Type Description
input string payload of a tag 1 packet
position integer position to start reading from the input string
len integer length of the packet or the remaining length of input at position
Source:
  • openpgp.js, line 1553
Returns:
object representation
Type
openpgp_packet_encrypteddata

<inner> read_symmetric_key_packet

parsing function for a symmetric encrypted session key packet (tag 3).
Parameters:
Name Type Description
input string payload of a tag 1 packet
position integer position to start reading from the input string
len integer length of the packet or the remaining length of input at position
Source:
  • openpgp.js, line 1641
Returns:
object representation
Type
openpgp_packet_encrypteddata

<inner> toString

Creates a string representation of this object (useful for debug purposes)
Source:
  • openpgp.js, line 1700
Returns:
the string containing a openpgp description

<inner> write_pub_key_packet

create a string representation of a tag 1 packet
Parameters:
Name Type Description
publicKeyId String the public key id corresponding to publicMPIs key as string
publicMPIs Array[openpgp_type_mpi] multiprecision integer objects describing the public key
pubalgo integer the corresponding public key algorithm // See RFC4880 9.1
symmalgo integer the symmetric cipher algorithm used to encrypt the data within an encrypteddatapacket or encryptedintegrityprotecteddatapacket following this packet //See RFC4880 9.2
sessionkey String a string of randombytes representing the session key
Source:
  • openpgp.js, line 1610
Returns:
the string representation
Type
String