Remove "MLS" prefix on structs

mlswg / mls-protocol

MLS protocol

https://messaginglayersecurity.rocks

Other

232 stars 61 forks source link

Remove "MLS" prefix on structs #839

Closed bifurcation closed 1 year ago

bifurcation commented 1 year ago

Fixes #759

As discussed in #759, this PR makes the following terminology changes:

Before	After
MLSMessage	MLSMessage
MLSContent	GroupContent
MLSContentTBS	GroupContentTBS
MLSContentAuthData	GroupContentAuthData
MLSAuthenticatedContent	AuthenticatedContent
MLSContentTBM	AuthenticatedContentTBM
MLSSenderData	SenderData
MLSSenderDataAAD	SenderDataAAD
MLSCiphertextContent	AuthenticatedContentTBE
MLSCiphertextContentAAD	ContentAAD
MLSPlaintext	PublicMessage
MLSCiphertext	PrivateMessage

It might be useful to review the two commits here separately. The first is just a global search-and-replace. The second is a light review for grammar ("a" vs. "an"), and makes a few small copy edits.

rohan-wire commented 1 year ago

I have a slight preference for SignedMessage and EncryptedMessage instead of PublicMessage and PrivateMessage

bifurcation commented 1 year ago

As discussed in the interim 2022-12-16:

Keeping Public/Private
GroupContent -> FramedContent
ContentAAD -> PrivateContentAAD
I also added: AuthenticatedContentTBE -> PrivateContentTBE (to be parallel with PrivateContentAAD)

TWal commented 1 year ago

For anyone wondering, here are the final changes made by this PR.

Before	After
MLSMessage	MLSMessage
MLSContent	FramedContent
MLSContentTBS	FramedContentTBS
MLSContentAuthData	FramedContentAuthData
MLSAuthenticatedContent	AuthenticatedContent
MLSContentTBM	AuthenticatedContentTBM
MLSSenderData	SenderData
MLSSenderDataAAD	SenderDataAAD
MLSCiphertextContent	PrivateContentTBE
MLSCiphertextContentAAD	PrivateContentAAD
MLSPlaintext	PublicMessage
MLSCiphertext	PrivateMessage

Which makes me wonder: since SenderData is only meant to be encrypted, shouldn't it be SenderDataTBE?