Skip to content

[ENG-38065, ENG-40352, pyapi] Document high-level decrypt API in Python#146

Open
TamLyNhat wants to merge 1 commit into
mainfrom
tamly/tamly/ENG-40352-doc-decrypt-python
Open

[ENG-38065, ENG-40352, pyapi] Document high-level decrypt API in Python#146
TamLyNhat wants to merge 1 commit into
mainfrom
tamly/tamly/ENG-40352-doc-decrypt-python

Conversation

@TamLyNhat

Copy link
Copy Markdown
Collaborator

No description provided.

@TamLyNhat TamLyNhat closed this Jul 17, 2026
@TamLyNhat TamLyNhat reopened this Jul 17, 2026
Encrypted string values can only be decrypted using `decrypt()`, when NSO is running with the correct [cryptographic keys](../../administration/advanced-topics/cryptographic-keys.md). Python example:
Encrypted string values can only be decrypted using `decrypt()`, when NSO is running with the correct [cryptographic keys](../../administration/advanced-topics/cryptographic-keys.md).

The recommended way from Python is `ncs.maapi.Maapi.decrypt()`, which installs the AES keys into the library on its first call and delegates to the low-level `decrypt` function on subsequent calls:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The recommended way from Python is `ncs.maapi.Maapi.decrypt()`, which installs the AES keys into the library on its first call and delegates to the low-level `decrypt` function on subsequent calls:
The recommended way for Python is to use `ncs.maapi.Maapi.decrypt()`, which installs the AES keys into the library on its first call and delegates to the low-level `decrypt` function on subsequent calls:

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @bbcsco,

You are so fast, I am waiting the CI run finishes in the main PR, then I will ask the review at the same time. Thanks for your comment, I will fix in next commit.

@TamLyNhat
TamLyNhat force-pushed the tamly/tamly/ENG-40352-doc-decrypt-python branch from a61f7aa to 948790a Compare July 17, 2026 08:39
@TamLyNhat
TamLyNhat force-pushed the tamly/tamly/ENG-40352-doc-decrypt-python branch from 948790a to f7296d0 Compare July 17, 2026 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants