WOLFRAM

Wolfram Language & System Documentation Center

SymmetricKey[assoc]

represents all the information needed for encryption, decryption, and other operations in a symmetric cryptographic system.

Details
Details and Options Details and Options
Examples  
Basic Examples  
Scope  
See Also
Related Guides
History
Cite this Page

SymmetricKey

SymmetricKey[assoc]

represents all the information needed for encryption, decryption, and other operations in a symmetric cryptographic system.

Details

  • SymmetricKey objects can be used with functions such as Encrypt and Decrypt.
  • A single SymmetricKey object can be used for both encryption and decryption.
  • SymmetricKey[…]["prop"] yields properties of the symmetric key. Possible properties include:
  • "Cipher"cipher used
    "Key"key as a ByteArray
    "KeySize"size of key in bits
  • Possible methods are as listed for GenerateSymmetricKey.
  • SymmetricKey[…]["Parameters"] gives all the information contained in the object, as an association.
  • SymmetricKey[…]["Properties"]
    • gives a list of available properties.

Examples

open all close all

Basic Examples  (1)

Generate a random symmetric key:

Wolfram Language code: key = GenerateSymmetricKey[]

Use the key to encrypt:

Wolfram Language code: msg = Encrypt[key, "Now is the time..."]

Decrypt the message:

Wolfram Language code: Decrypt[key, msg]

Scope  (1)

Retrieve keys and values from the associations with a SymmetricKey object:

Wolfram Language code: key = GenerateSymmetricKey[]
Wolfram Language code: key["Cipher"]
Wolfram Language code: key["Key"]
Wolfram Language code: key["KeySize"]

Extract all the information about the key:

Wolfram Language code: key["Parameters"]
Wolfram Research (2015), SymmetricKey, Wolfram Language function, https://reference.wolfram.com/language/ref/SymmetricKey.html (updated 2020).

Text

Wolfram Research (2015), SymmetricKey, Wolfram Language function, https://reference.wolfram.com/language/ref/SymmetricKey.html (updated 2020).

CMS

Wolfram Language. 2015. "SymmetricKey." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2020. https://reference.wolfram.com/language/ref/SymmetricKey.html.

APA

Wolfram Language. (2015). SymmetricKey. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SymmetricKey.html

BibTeX

@misc{reference.wolfram_2026_symmetrickey, author="Wolfram Research", title="{SymmetricKey}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/SymmetricKey.html}", note=[Accessed: 13-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_symmetrickey, organization={Wolfram Research}, title={SymmetricKey}, year={2020}, url={https://reference.wolfram.com/language/ref/SymmetricKey.html}, note=[Accessed: 13-June-2026]}