-
Notifications
You must be signed in to change notification settings - Fork 26
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
Naming conventions #25
Comments
There are two sides to this, ideally this should follow Go idioms. However, there are a few projects that rely on this library. Most notably, SpiderOak's Semaphor. At some point we should rename the folders though, perhaps a new branch for a 2.0 version? But Go does not support different versions of the same library very easy. |
It is not necessary to rename existing files immediately because the package names do not clash. They can exist side by side and they could be deprecated at some later date. I noticed it eases development greatly to change the naming scheme. Especially because the tests are more portable. I have wrapped all |
I merged #31 but we should write something about the new structure, otherwise people may try to use both sets of the AEAD functions. I may create a version with just the new AEAD structure. |
As
golint
helpfully points out:It gets especially cumbersome with functions like:
cryptoaead.CryptoAEADAES256GCMEncrypt
.Additionally, overlap in naming with with
crypto/nacl
could result in making this library a drop-in replacement.I think the most convenient way to structure the packages would be
crypto/box
,crypto/aead/aes256gcm
andcrypto/stream/xsalsa20
.Renaming, however, does break backward compatibility in a major way.
The text was updated successfully, but these errors were encountered: