Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation missing for decrypt VRL function reference #20648

Closed
alisa101rs opened this issue Jun 12, 2024 · 1 comment · Fixed by #20658
Closed

Documentation missing for decrypt VRL function reference #20648

alisa101rs opened this issue Jun 12, 2024 · 1 comment · Fixed by #20658
Labels
type: bug A code related bug.

Comments

@alisa101rs
Copy link

A note for the community

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Problem

I am sorry if I file this issue in the wrong repository.

I think that both encrypt and decrypt vrl functions support the same list of algorithms (see implementation). But algorithm list for decrypt vrl function is different from list for encrypt in official reference documentation.

This

remap: functions: decrypt: {
category: "Cryptography"
description: """
Decrypts a string with a symmetric encryption algorithm.
Supported Algorithms:
* AES-256-CFB (key = 32 bytes, iv = 16 bytes)
* AES-192-CFB (key = 24 bytes, iv = 16 bytes)
* AES-128-CFB (key = 16 bytes, iv = 16 bytes)
* AES-256-OFB (key = 32 bytes, iv = 16 bytes)
* AES-192-OFB (key = 24 bytes, iv = 16 bytes)
* AES-128-OFB (key = 16 bytes, iv = 16 bytes)
* AES-256-CTR (key = 32 bytes, iv = 16 bytes)
* AES-192-CTR (key = 24 bytes, iv = 16 bytes)
* AES-128-CTR (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-PKCS7 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-PKCS7 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-PKCS7 (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-ANSIX923 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-ANSIX923 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-ANSIX923 (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-ISO7816 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-ISO7816 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-ISO7816 (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-ISO10126 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-ISO10126 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-ISO10126 (key = 16 bytes, iv = 16 bytes)
"""

should be the same as this
remap: functions: encrypt: {
category: "Cryptography"
description: """
Encrypts a string with a symmetric encryption algorithm.
Supported Algorithms:
* AES-256-CFB (key = 32 bytes, iv = 16 bytes)
* AES-192-CFB (key = 24 bytes, iv = 16 bytes)
* AES-128-CFB (key = 16 bytes, iv = 16 bytes)
* AES-256-OFB (key = 32 bytes, iv = 16 bytes)
* AES-192-OFB (key = 24 bytes, iv = 16 bytes)
* AES-128-OFB (key = 16 bytes, iv = 16 bytes)
* Deprecated - AES-256-CTR (key = 32 bytes, iv = 16 bytes)
* Deprecated - AES-192-CTR (key = 24 bytes, iv = 16 bytes)
* Deprecated - AES-128-CTR (key = 16 bytes, iv = 16 bytes)
* AES-256-CTR-LE (key = 32 bytes, iv = 16 bytes)
* AES-192-CTR-LE (key = 24 bytes, iv = 16 bytes)
* AES-128-CTR-LE (key = 16 bytes, iv = 16 bytes)
* AES-256-CTR-BE (key = 32 bytes, iv = 16 bytes)
* AES-192-CTR-BE (key = 24 bytes, iv = 16 bytes)
* AES-128-CTR-BE (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-PKCS7 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-PKCS7 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-PKCS7 (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-ANSIX923 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-ANSIX923 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-ANSIX923 (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-ISO7816 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-ISO7816 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-ISO7816 (key = 16 bytes, iv = 16 bytes)
* AES-256-CBC-ISO10126 (key = 32 bytes, iv = 16 bytes)
* AES-192-CBC-ISO10126 (key = 24 bytes, iv = 16 bytes)
* AES-128-CBC-ISO10126 (key = 16 bytes, iv = 16 bytes)
* CHACHA20-POLY1305 (key = 32 bytes, iv = 12 bytes)
* XCHACHA20-POLY1305 (key = 32 bytes, iv = 24 bytes)
* XSALSA20-POLY1305 (key = 32 bytes, iv = 24 bytes)
"""

Configuration

No response

Version

https://vector.dev

Debug Output

No response

Example Data

No response

Additional Context

No response

References

No response

@jszwedko
Copy link
Member

Thanks for the report! Opened #20658 to correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug A code related bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants