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

Jump to bottom

crypto/rsa: documentation for OAEP missing some details #13711

Closed
robpike opened this issue Dec 22, 2015 · 2 comments
Closed

crypto/rsa: documentation for OAEP missing some details #13711

robpike opened this issue Dec 22, 2015 · 2 comments
Labels
FrozenDueToAge
Milestone
Unplanned

Comments

@robpike
Copy link
Contributor

robpike commented Dec 22, 2015

I used the crypto/rsa's OAEP facility but found it difficult to work out given the documentation. I am not crypto-savvy so some of the details may be obvious to those skilled in the art, but perhaps it makes it even more important to document well to avoid trouble from dangerous beginners like myself.

Some requests:

The package badly needs examples overall.

The comments on the constants are inscrutable.

The purpose of the noise source in EncryptOAEP is unclear. Moreover, it looks like it cannot ever be nil. What do its properties need to be?

Ditto for DecryptOAEP, although here the source can be nil, empirically. What is the relationship between this noise source and the one in EncryptOAEP, if any?

If DecryptOAEP succeeds, that is, gets no error, what does that mean? Is further validation required? (This is one where an expert almost certainly knows this, but it wouldn't hurt to say.)
@robpike robpike added this to the Unplanned milestone Dec 22, 2015
@gopherbot
Copy link

CL https://golang.org/cl/18486 mentions this issue.

gopherbot pushed a commit that referenced this issue Jan 27, 2016
@agl @bradfitz
crypto/rsa: expand on documentation and add some examples.
8437452 
In some cases the documentation for functions in this package was
lacking from the beginning and, in order cases, the documentation didn't
keep pace as the package grew.

This change somewhat addresses that.

Updates #13711.

Change-Id: I25b2bb1fcd4658c5417671e23cf8e644d08cb9ab
Reviewed-on: https://go-review.googlesource.com/18486
Reviewed-by: Rob Pike <r@golang.org>
Reviewed-by: Andrew Gerrand <adg@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
@agl
Copy link
Contributor

agl commented Mar 10, 2016

Hopefully this is mostly addressed now.

@agl agl closed this as completed Mar 10, 2016
@golang golang locked and limited conversation to collaborators Mar 13, 2017
@rsc rsc unassigned agl Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge
Projects
None yet
Milestone
Unplanned
Development

No branches or pull requests
3 participants
@agl @robpike @gopherbot