signalapp/SignalMetadataKit
signalapp/SignalMetadataKit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial code drop.

Browse Source
This commit is contained in:
Matthew Chen 2018-09-25 12:50:15 -04:00
parent 977f977e09
commit be07295237
28 changed files with 5002 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,83 @@
# Contributing to Signal iOS
Thank you for supporting Signal and looking for ways to help. Please note that some conventions here might be a bit different than what you are used to, even if you have contributed to other open source projects before. Reading this document will help you save time and work effectively with the developers and other contributors.
## Development Ideology
Truths which we believe to be self-evident:
1. **The answer is not more options.** If you feel compelled to add a preference that's exposed to the user, it's very possible you've made a wrong turn somewhere.
1. **The user doesn't know what a key is.** We need to minimize the points at which a user is exposed to this sort of terminology as extremely as possible.
1. **There are no power users.** The idea that some users "understand" concepts better than others has proven to be, for the most part, false. If anything, "power users" are more dangerous than the rest, and we should avoid exposing dangerous functionality to them.
1. **If it's "like PGP," it's wrong.** PGP is our guide for what not to do.
1. **It's an asynchronous world.** Be wary of anything that is anti-asynchronous: ACKs, protocol confirmations, or any protocol-level "advisory" message.
1. **There is no such thing as time.** Protocol ideas that require synchronized clocks are doomed to failure.
## Translations
Thanks to a dedicated community of volunteer translators, Signal is now available in more than one hundred languages. We use Transifex to manage our translation efforts, not GitHub. Any suggestions, corrections, or new translations should be submitted to the [Signal localization project for iOS](https://www.transifex.com/signalapp/signal-ios/).
## Issues
Please search both open and closed issues to make sure your bug report is not a duplicate.
### The issue tracker is for bugs, not feature requests
The GitHub issue tracker is not used for feature requests, but new ideas can be submitted and discussed on the [community forum](https://community.signalusers.org/c/feature-requests). The purpose of this issue tracker is to track bugs in the iOS client. Bug reports should only be submitted for existing functionality that does not work as intended. Comments that are relevant and concise will help the developers solve issues more quickly.
### Send support questions to support
You can reach support by sending an email to support@signal.org or by visiting the [Signal Support Center](https://support.signal.org/) where you can also search for existing troubleshooting articles and find answers to frequently asked questions. Please do not post support questions on the GitHub issue tracker.
### GitHub is not a generic discussion forum
Conversations about open bug reports belong here. However, all other discussions should take place on the [community forum](https://community.signalusers.org). You can use the community forum to discuss anything that is related to Signal or to hang out with your fellow users in the "Off Topic" category.
### Don't bump issues
Every time someone comments on an issue, GitHub sends an email to [hundreds of people](https://github.com/signalapp/Signal-iOS/watchers). Bumping issues with a "+1" (or asking for updates) generates a lot of unnecessary email notifications and does not help anyone solve the issue any faster. Please be respectful of everyone's time and only comment when you have new information to add.
### Open issues
#### If it's open, it's tracked
The developers read every issue, but high-priority bugs or features can take precedence over others. Signal is an open source project, and everyone is encouraged to play an active role in diagnosing and fixing open issues.
### Closed issues
#### "My issue was closed without giving a reason!"
Although we do our best, writing detailed explanations for every issue can be time consuming, and the topic also might have been covered previously in other related issues.
## Pull requests
### Smaller is better
Big changes are significantly less likely to be accepted. Large features often require protocol modifications and necessitate a staged rollout process that is coordinated across millions of users on multiple platforms (Android, iOS, and Desktop).
Try not to take on too much at once. As a first-time contributor, we recommend starting with small and simple PRs in order to become familiar with the codebase. Most of the work should go into discovering which three lines need to change rather than writing the code.
### Sign the Contributor License Agreement (CLA)
You will need to [sign our CLA](https://signal.org/cla/) before your pull request can be merged.
### Submit finished and well-tested pull requests
Please do not submit pull requests that are still a work in progress. Pull requests should be thoroughly tested and ready to merge before they are submitted.
### Merging can sometimes take a while
If your pull request follows all of the advice above but still has not been merged, this usually means that the developers haven't had time to review it yet. We understand that this might feel frustrating, and we apologize. The Signal team is still small, but [we are hiring](https://signal.org/workworkwork/).
## How can I contribute?
There are several other ways to get involved:
* Help new users learn about Signal.
* Redirect support questions to support@signal.org and the [Signal Support Center](https://support.signal.org/).
* Redirect non-bug discussions to the [community forum](https://community.signalusers.org).
* Improve documentation in the [wiki](https://github.com/signalapp/Signal-iOS/wiki).
* Join the community of volunteer translators on Transifex:
* [Android](https://www.transifex.com/projects/p/signal-android/)
* [iOS](https://www.transifex.com/signalapp/signal-ios/)
* [Desktop](https://www.transifex.com/signalapp/signal-desktop/)
* Find and mark duplicate issues.
* Try to reproduce issues and help with troubleshooting.
* Discover solutions to open issues and post any relevant findings.
* Test other people's pull requests.
* Contribute to Signal via the [Freedom of the Press Foundation's donation page](https://freedom.press/crowdfunding/signal/).
* Share Signal with your friends and family.
Signal is made for you. Thank you for your feedback and support.

621
LICENSE Normal file
View File

@ -0,0 +1,621 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS

28
README.md
View File

@ -1 +1,27 @@
# SignalMetadataKit-Private
# SignalMetadataKit for iOS
## Translation
Help us translate Signal! The translation effort happens on [Transifex](https://www.transifex.com/signalapp/signal-ios/)
## Contributing Code
Instructions on how to set up your development environment and build Signal-iOS can be found in [BUILDING.md](https://github.com/signalapp/Signal-iOS/blob/master/BUILDING.md). Other useful instructions for development can be found on the [Development Guide wiki page](https://github.com/signalapp/Signal-iOS/wiki/Development-Guide). We also recommend reading the [contribution guidelines](https://github.com/signalapp/Signal-iOS/blob/master/CONTRIBUTING.md).
## Contributing Ideas
Have something you want to say about Open Whisper Systems projects or want to be part of the conversation? Get involved in the [community forum](https://community.signalusers.org).
## Cryptography Notice
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software.
BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted.
See <http://www.wassenaar.org/> for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms.
The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.
## License
Copyright 2014-2018 Open Whisper Systems
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html

54
SignalMetadataKit.podspec Normal file
View File

@ -0,0 +1,54 @@
#
# Be sure to run `pod lib lint SignalMetadataKit.podspec' to ensure this is a
# valid spec before submitting.
#
# Any lines starting with a # are optional, but their use is encouraged
# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
#
Pod::Spec.new do |s|
s.name = "SignalMetadataKit"
s.version = "1.0.0"
s.summary = "A Swift & Objective-C library used by other Signal libraries."
s.description = <<-DESC
A Swift & Objective-C library used by other Signal libraries.
DESC
s.homepage = "https://github.com/signalapp/SignalMetadataKit"
s.license = 'GPLv3'
s.author = { "iOS Team" => "ios@signal.org" }
s.source = { :git => "https://github.com/signalapp/SignalMetadataKit.git", :tag => s.version.to_s }
s.social_media_url = 'https://twitter.com/signalapp'
s.platform = :ios, '9.0'
#s.ios.deployment_target = '9.0'
#s.osx.deployment_target = '10.9'
s.requires_arc = true
s.source_files = 'SignalMetadataKit/src/**/*.{h,m,mm,swift}', 'SignalMetadataKit/Private/**/*.{h,m,mm,swift}'
s.public_header_files = 'SignalMetadataKit/src/**/*.h'
# We want to use modules to avoid clobbering CocoaLumberjack macros defined
# by other OWS modules which *also* import CocoaLumberjack. But because we
# also use Objective-C++, modules are disabled unless we explicitly enable
# them
s.compiler_flags = "-fcxx-modules"
s.prefix_header_file = 'SignalMetadataKit/SMKPrefix.h'
s.xcconfig = { 'OTHER_CFLAGS' => '$(inherited) -DSQLITE_HAS_CODEC' }
s.resources = ["SignalMetadataKit/Resources/Certificates/*"]
s.dependency 'AxolotlKit'
s.dependency 'CocoaLumberjack'
s.dependency 'Curve25519Kit'
s.dependency 'HKDFKit'
s.dependency 'SignalCoreKit'
s.dependency 'SwiftProtobuf'
s.test_spec 'Tests' do |test_spec|
test_spec.source_files = 'SignalMetadataKitTests/src/**/*.{h,m,swift}'
end
end

7
SignalMetadataKit/SMKPrefix.h Normal file
View File

@ -0,0 +1,7 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <SignalCoreKit/NSObject+OWS.h>
#import <SignalCoreKit/OWSAsserts.h>

32
SignalMetadataKit/src/ECPrivateKey.swift Normal file
View File

@ -0,0 +1,32 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// See:
// https://github.com/signalapp/libsignal-protocol-java/blob/87fae0f98332e98a32bbb82515428b4edeb4181f/java/src/main/java/org/whispersystems/libsignal/ecc/ECPrivateKey.java
@objc public class ECPrivateKey: NSObject {
@objc public let keyData: Data
@objc public init(keyData: Data) throws {
guard keyData.count == ECCKeyLength else {
throw SMKError.assertionError(description: "\(ECPrivateKey.logTag) key has invalid length")
}
self.keyData = keyData
}
open override func isEqual(_ object: Any?) -> Bool {
if let object = object as? ECPrivateKey {
return keyData == object.keyData
} else {
return false
}
}
public override var hash: Int {
return keyData.hashValue
}
}

57
SignalMetadataKit/src/ECPublicKey.swift Normal file
View File

@ -0,0 +1,57 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// See:
// https://github.com/signalapp/libsignal-protocol-java/blob/87fae0f98332e98a32bbb82515428b4edeb4181f/java/src/main/java/org/whispersystems/libsignal/ecc/DjbECPublicKey.java
@objc public class ECPublicKey: NSObject {
public static let keyTypeDJB: UInt8 = 0x05
@objc public let keyData: Data
public init(keyData: Data) throws {
guard keyData.count == ECCKeyLength else {
throw SMKError.assertionError(description: "\(ECPublicKey.logTag) key has invalid length")
}
self.keyData = keyData
}
// https://github.com/signalapp/libsignal-protocol-java/blob/master/java/src/main/java/org/whispersystems/libsignal/ecc/Curve.java#L30
public init(serializedKeyData: Data) throws {
let parser = SSKDataParser(data: serializedKeyData)
let typeByte = try parser.nextByte(name: "type byte")
guard typeByte == ECPublicKey.keyTypeDJB else {
throw SMKError.assertionError(description: "\(ECPublicKey.logTag) key data has invalid type byte")
}
let keyData = try parser.remainder(name: "key data")
guard keyData.count == ECCKeyLength else {
throw SMKError.assertionError(description: "\(ECPublicKey.logTag) key has invalid length")
}
self.keyData = keyData
}
@objc public var serialized: Data {
let typeBytes = [ECPublicKey.keyTypeDJB]
let typeData = Data(bytes: typeBytes)
return NSData.join([typeData, keyData])
}
open override func isEqual(_ object: Any?) -> Bool {
if let object = object as? ECPublicKey {
return keyData == object.keyData
} else {
return false
}
}
public override var hash: Int {
return keyData.hashValue
}
}

628
SignalMetadataKit/src/Generated/OWSUnidentifiedDelivery.pb.swift Normal file
View File

@ -0,0 +1,628 @@
// DO NOT EDIT.
//
// Generated by the Swift generator plugin for the protocol buffer compiler.
// Source: OWSUnidentifiedDelivery.proto
//
// For information on using the generated types, please see the documenation:
// https://github.com/apple/swift-protobuf/
//*
// Copyright (C) 2014-2016 Open Whisper Systems
//
// Licensed according to the LICENSE file in this repository.
/// iOS - since we use a modern proto-compiler, we must specify
/// the legacy proto format.
import Foundation
import SwiftProtobuf
// If the compiler emits an error on this type, it is because this file
// was generated by a version of the `protoc` Swift plug-in that is
// incompatible with the version of SwiftProtobuf to which you are linking.
// Please ensure that your are building against the same version of the API
// that was used to generate this file.
fileprivate struct _GeneratedWithProtocGenSwiftVersion: SwiftProtobuf.ProtobufAPIVersionCheck {
struct _2: SwiftProtobuf.ProtobufAPIVersion_2 {}
typealias Version = _2
}
struct SMKProtos_ServerCertificate {
// SwiftProtobuf.Message conformance is added in an extension below. See the
// `Message` and `Message+*Additions` files in the SwiftProtobuf library for
// methods supported on all messages.
/// @required
var certificate: Data {
get {return _certificate ?? SwiftProtobuf.Internal.emptyData}
set {_certificate = newValue}
}
/// Returns true if `certificate` has been explicitly set.
var hasCertificate: Bool {return self._certificate != nil}
/// Clears the value of `certificate`. Subsequent reads from it will return its default value.
mutating func clearCertificate() {self._certificate = nil}
/// @required
var signature: Data {
get {return _signature ?? SwiftProtobuf.Internal.emptyData}
set {_signature = newValue}
}
/// Returns true if `signature` has been explicitly set.
var hasSignature: Bool {return self._signature != nil}
/// Clears the value of `signature`. Subsequent reads from it will return its default value.
mutating func clearSignature() {self._signature = nil}
var unknownFields = SwiftProtobuf.UnknownStorage()
struct Certificate {
// SwiftProtobuf.Message conformance is added in an extension below. See the
// `Message` and `Message+*Additions` files in the SwiftProtobuf library for
// methods supported on all messages.
/// @required
var id: UInt32 {
get {return _id ?? 0}
set {_id = newValue}
}
/// Returns true if `id` has been explicitly set.
var hasID: Bool {return self._id != nil}
/// Clears the value of `id`. Subsequent reads from it will return its default value.
mutating func clearID() {self._id = nil}
/// @required
var key: Data {
get {return _key ?? SwiftProtobuf.Internal.emptyData}
set {_key = newValue}
}
/// Returns true if `key` has been explicitly set.
var hasKey: Bool {return self._key != nil}
/// Clears the value of `key`. Subsequent reads from it will return its default value.
mutating func clearKey() {self._key = nil}
var unknownFields = SwiftProtobuf.UnknownStorage()
init() {}
fileprivate var _id: UInt32? = nil
fileprivate var _key: Data? = nil
}
init() {}
fileprivate var _certificate: Data? = nil
fileprivate var _signature: Data? = nil
}
struct SMKProtos_SenderCertificate {
// SwiftProtobuf.Message conformance is added in an extension below. See the
// `Message` and `Message+*Additions` files in the SwiftProtobuf library for
// methods supported on all messages.
/// @required
var certificate: Data {
get {return _certificate ?? SwiftProtobuf.Internal.emptyData}
set {_certificate = newValue}
}
/// Returns true if `certificate` has been explicitly set.
var hasCertificate: Bool {return self._certificate != nil}
/// Clears the value of `certificate`. Subsequent reads from it will return its default value.
mutating func clearCertificate() {self._certificate = nil}
/// @required
var signature: Data {
get {return _signature ?? SwiftProtobuf.Internal.emptyData}
set {_signature = newValue}
}
/// Returns true if `signature` has been explicitly set.
var hasSignature: Bool {return self._signature != nil}
/// Clears the value of `signature`. Subsequent reads from it will return its default value.
mutating func clearSignature() {self._signature = nil}
var unknownFields = SwiftProtobuf.UnknownStorage()
struct Certificate {
// SwiftProtobuf.Message conformance is added in an extension below. See the
// `Message` and `Message+*Additions` files in the SwiftProtobuf library for
// methods supported on all messages.
/// @required
var sender: String {
get {return _storage._sender ?? String()}
set {_uniqueStorage()._sender = newValue}
}
/// Returns true if `sender` has been explicitly set.
var hasSender: Bool {return _storage._sender != nil}
/// Clears the value of `sender`. Subsequent reads from it will return its default value.
mutating func clearSender() {_storage._sender = nil}
/// @required
var senderDevice: UInt32 {
get {return _storage._senderDevice ?? 0}
set {_uniqueStorage()._senderDevice = newValue}
}
/// Returns true if `senderDevice` has been explicitly set.
var hasSenderDevice: Bool {return _storage._senderDevice != nil}
/// Clears the value of `senderDevice`. Subsequent reads from it will return its default value.
mutating func clearSenderDevice() {_storage._senderDevice = nil}
/// @required
var expires: UInt64 {
get {return _storage._expires ?? 0}
set {_uniqueStorage()._expires = newValue}
}
/// Returns true if `expires` has been explicitly set.
var hasExpires: Bool {return _storage._expires != nil}
/// Clears the value of `expires`. Subsequent reads from it will return its default value.
mutating func clearExpires() {_storage._expires = nil}
/// @required
var identityKey: Data {
get {return _storage._identityKey ?? SwiftProtobuf.Internal.emptyData}
set {_uniqueStorage()._identityKey = newValue}
}
/// Returns true if `identityKey` has been explicitly set.
var hasIdentityKey: Bool {return _storage._identityKey != nil}
/// Clears the value of `identityKey`. Subsequent reads from it will return its default value.
mutating func clearIdentityKey() {_storage._identityKey = nil}
/// @required
var signer: SMKProtos_ServerCertificate {
get {return _storage._signer ?? SMKProtos_ServerCertificate()}
set {_uniqueStorage()._signer = newValue}
}
/// Returns true if `signer` has been explicitly set.
var hasSigner: Bool {return _storage._signer != nil}
/// Clears the value of `signer`. Subsequent reads from it will return its default value.
mutating func clearSigner() {_storage._signer = nil}
var unknownFields = SwiftProtobuf.UnknownStorage()
init() {}
fileprivate var _storage = _StorageClass.defaultInstance
}
init() {}
fileprivate var _certificate: Data? = nil
fileprivate var _signature: Data? = nil
}
struct SMKProtos_UnidentifiedSenderMessage {
// SwiftProtobuf.Message conformance is added in an extension below. See the
// `Message` and `Message+*Additions` files in the SwiftProtobuf library for
// methods supported on all messages.
/// @required
var ephemeralPublic: Data {
get {return _ephemeralPublic ?? SwiftProtobuf.Internal.emptyData}
set {_ephemeralPublic = newValue}
}
/// Returns true if `ephemeralPublic` has been explicitly set.
var hasEphemeralPublic: Bool {return self._ephemeralPublic != nil}
/// Clears the value of `ephemeralPublic`. Subsequent reads from it will return its default value.
mutating func clearEphemeralPublic() {self._ephemeralPublic = nil}
/// @required
var encryptedStatic: Data {
get {return _encryptedStatic ?? SwiftProtobuf.Internal.emptyData}
set {_encryptedStatic = newValue}
}
/// Returns true if `encryptedStatic` has been explicitly set.
var hasEncryptedStatic: Bool {return self._encryptedStatic != nil}
/// Clears the value of `encryptedStatic`. Subsequent reads from it will return its default value.
mutating func clearEncryptedStatic() {self._encryptedStatic = nil}
/// @required
var encryptedMessage: Data {
get {return _encryptedMessage ?? SwiftProtobuf.Internal.emptyData}
set {_encryptedMessage = newValue}
}
/// Returns true if `encryptedMessage` has been explicitly set.
var hasEncryptedMessage: Bool {return self._encryptedMessage != nil}
/// Clears the value of `encryptedMessage`. Subsequent reads from it will return its default value.
mutating func clearEncryptedMessage() {self._encryptedMessage = nil}
var unknownFields = SwiftProtobuf.UnknownStorage()
struct Message {
// SwiftProtobuf.Message conformance is added in an extension below. See the
// `Message` and `Message+*Additions` files in the SwiftProtobuf library for
// methods supported on all messages.
/// @required
var type: SMKProtos_UnidentifiedSenderMessage.Message.TypeEnum {
get {return _storage._type ?? .prekeyMessage}
set {_uniqueStorage()._type = newValue}
}
/// Returns true if `type` has been explicitly set.
var hasType: Bool {return _storage._type != nil}
/// Clears the value of `type`. Subsequent reads from it will return its default value.
mutating func clearType() {_storage._type = nil}
/// @required
var senderCertificate: SMKProtos_SenderCertificate {
get {return _storage._senderCertificate ?? SMKProtos_SenderCertificate()}
set {_uniqueStorage()._senderCertificate = newValue}
}
/// Returns true if `senderCertificate` has been explicitly set.
var hasSenderCertificate: Bool {return _storage._senderCertificate != nil}
/// Clears the value of `senderCertificate`. Subsequent reads from it will return its default value.
mutating func clearSenderCertificate() {_storage._senderCertificate = nil}
/// @required
var content: Data {
get {return _storage._content ?? SwiftProtobuf.Internal.emptyData}
set {_uniqueStorage()._content = newValue}
}
/// Returns true if `content` has been explicitly set.
var hasContent: Bool {return _storage._content != nil}
/// Clears the value of `content`. Subsequent reads from it will return its default value.
mutating func clearContent() {_storage._content = nil}
var unknownFields = SwiftProtobuf.UnknownStorage()
enum TypeEnum: SwiftProtobuf.Enum {
typealias RawValue = Int
case prekeyMessage // = 1
case message // = 2
init() {
self = .prekeyMessage
}
init?(rawValue: Int) {
switch rawValue {
case 1: self = .prekeyMessage
case 2: self = .message
default: return nil
}
}
var rawValue: Int {
switch self {
case .prekeyMessage: return 1
case .message: return 2
}
}
}
init() {}
fileprivate var _storage = _StorageClass.defaultInstance
}
init() {}
fileprivate var _ephemeralPublic: Data? = nil
fileprivate var _encryptedStatic: Data? = nil
fileprivate var _encryptedMessage: Data? = nil
}
// MARK: - Code below here is support for the SwiftProtobuf runtime.
fileprivate let _protobuf_package = "SMKProtos"
extension SMKProtos_ServerCertificate: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
static let protoMessageName: String = _protobuf_package + ".ServerCertificate"
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "certificate"),
2: .same(proto: "signature"),
]
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
switch fieldNumber {
case 1: try decoder.decodeSingularBytesField(value: &self._certificate)
case 2: try decoder.decodeSingularBytesField(value: &self._signature)
default: break
}
}
}
func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
if let v = self._certificate {
try visitor.visitSingularBytesField(value: v, fieldNumber: 1)
}
if let v = self._signature {
try visitor.visitSingularBytesField(value: v, fieldNumber: 2)
}
try unknownFields.traverse(visitor: &visitor)
}
func _protobuf_generated_isEqualTo(other: SMKProtos_ServerCertificate) -> Bool {
if self._certificate != other._certificate {return false}
if self._signature != other._signature {return false}
if unknownFields != other.unknownFields {return false}
return true
}
}
extension SMKProtos_ServerCertificate.Certificate: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
static let protoMessageName: String = SMKProtos_ServerCertificate.protoMessageName + ".Certificate"
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "id"),
2: .same(proto: "key"),
]
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
switch fieldNumber {
case 1: try decoder.decodeSingularUInt32Field(value: &self._id)
case 2: try decoder.decodeSingularBytesField(value: &self._key)
default: break
}
}
}
func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
if let v = self._id {
try visitor.visitSingularUInt32Field(value: v, fieldNumber: 1)
}
if let v = self._key {
try visitor.visitSingularBytesField(value: v, fieldNumber: 2)
}
try unknownFields.traverse(visitor: &visitor)
}
func _protobuf_generated_isEqualTo(other: SMKProtos_ServerCertificate.Certificate) -> Bool {
if self._id != other._id {return false}
if self._key != other._key {return false}
if unknownFields != other.unknownFields {return false}
return true
}
}
extension SMKProtos_SenderCertificate: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
static let protoMessageName: String = _protobuf_package + ".SenderCertificate"
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "certificate"),
2: .same(proto: "signature"),
]
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
switch fieldNumber {
case 1: try decoder.decodeSingularBytesField(value: &self._certificate)
case 2: try decoder.decodeSingularBytesField(value: &self._signature)
default: break
}
}
}
func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
if let v = self._certificate {
try visitor.visitSingularBytesField(value: v, fieldNumber: 1)
}
if let v = self._signature {
try visitor.visitSingularBytesField(value: v, fieldNumber: 2)
}
try unknownFields.traverse(visitor: &visitor)
}
func _protobuf_generated_isEqualTo(other: SMKProtos_SenderCertificate) -> Bool {
if self._certificate != other._certificate {return false}
if self._signature != other._signature {return false}
if unknownFields != other.unknownFields {return false}
return true
}
}
extension SMKProtos_SenderCertificate.Certificate: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
static let protoMessageName: String = SMKProtos_SenderCertificate.protoMessageName + ".Certificate"
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "sender"),
2: .same(proto: "senderDevice"),
3: .same(proto: "expires"),
4: .same(proto: "identityKey"),
5: .same(proto: "signer"),
]
fileprivate class _StorageClass {
var _sender: String? = nil
var _senderDevice: UInt32? = nil
var _expires: UInt64? = nil
var _identityKey: Data? = nil
var _signer: SMKProtos_ServerCertificate? = nil
static let defaultInstance = _StorageClass()
private init() {}
init(copying source: _StorageClass) {
_sender = source._sender
_senderDevice = source._senderDevice
_expires = source._expires
_identityKey = source._identityKey
_signer = source._signer
}
}
fileprivate mutating func _uniqueStorage() -> _StorageClass {
if !isKnownUniquelyReferenced(&_storage) {
_storage = _StorageClass(copying: _storage)
}
return _storage
}
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
_ = _uniqueStorage()
try withExtendedLifetime(_storage) { (_storage: _StorageClass) in
while let fieldNumber = try decoder.nextFieldNumber() {
switch fieldNumber {
case 1: try decoder.decodeSingularStringField(value: &_storage._sender)
case 2: try decoder.decodeSingularUInt32Field(value: &_storage._senderDevice)
case 3: try decoder.decodeSingularFixed64Field(value: &_storage._expires)
case 4: try decoder.decodeSingularBytesField(value: &_storage._identityKey)
case 5: try decoder.decodeSingularMessageField(value: &_storage._signer)
default: break
}
}
}
}
func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
try withExtendedLifetime(_storage) { (_storage: _StorageClass) in
if let v = _storage._sender {
try visitor.visitSingularStringField(value: v, fieldNumber: 1)
}
if let v = _storage._senderDevice {
try visitor.visitSingularUInt32Field(value: v, fieldNumber: 2)
}
if let v = _storage._expires {
try visitor.visitSingularFixed64Field(value: v, fieldNumber: 3)
}
if let v = _storage._identityKey {
try visitor.visitSingularBytesField(value: v, fieldNumber: 4)
}
if let v = _storage._signer {
try visitor.visitSingularMessageField(value: v, fieldNumber: 5)
}
}
try unknownFields.traverse(visitor: &visitor)
}
func _protobuf_generated_isEqualTo(other: SMKProtos_SenderCertificate.Certificate) -> Bool {
if _storage !== other._storage {
let storagesAreEqual: Bool = withExtendedLifetime((_storage, other._storage)) { (_args: (_StorageClass, _StorageClass)) in
let _storage = _args.0
let other_storage = _args.1
if _storage._sender != other_storage._sender {return false}
if _storage._senderDevice != other_storage._senderDevice {return false}
if _storage._expires != other_storage._expires {return false}
if _storage._identityKey != other_storage._identityKey {return false}
if _storage._signer != other_storage._signer {return false}
return true
}
if !storagesAreEqual {return false}
}
if unknownFields != other.unknownFields {return false}
return true
}
}
extension SMKProtos_UnidentifiedSenderMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
static let protoMessageName: String = _protobuf_package + ".UnidentifiedSenderMessage"
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "ephemeralPublic"),
2: .same(proto: "encryptedStatic"),
3: .same(proto: "encryptedMessage"),
]
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
while let fieldNumber = try decoder.nextFieldNumber() {
switch fieldNumber {
case 1: try decoder.decodeSingularBytesField(value: &self._ephemeralPublic)
case 2: try decoder.decodeSingularBytesField(value: &self._encryptedStatic)
case 3: try decoder.decodeSingularBytesField(value: &self._encryptedMessage)
default: break
}
}
}
func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
if let v = self._ephemeralPublic {
try visitor.visitSingularBytesField(value: v, fieldNumber: 1)
}
if let v = self._encryptedStatic {
try visitor.visitSingularBytesField(value: v, fieldNumber: 2)
}
if let v = self._encryptedMessage {
try visitor.visitSingularBytesField(value: v, fieldNumber: 3)
}
try unknownFields.traverse(visitor: &visitor)
}
func _protobuf_generated_isEqualTo(other: SMKProtos_UnidentifiedSenderMessage) -> Bool {
if self._ephemeralPublic != other._ephemeralPublic {return false}
if self._encryptedStatic != other._encryptedStatic {return false}
if self._encryptedMessage != other._encryptedMessage {return false}
if unknownFields != other.unknownFields {return false}
return true
}
}
extension SMKProtos_UnidentifiedSenderMessage.Message: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {
static let protoMessageName: String = SMKProtos_UnidentifiedSenderMessage.protoMessageName + ".Message"
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "type"),
2: .same(proto: "senderCertificate"),
3: .same(proto: "content"),
]
fileprivate class _StorageClass {
var _type: SMKProtos_UnidentifiedSenderMessage.Message.TypeEnum? = nil
var _senderCertificate: SMKProtos_SenderCertificate? = nil
var _content: Data? = nil
static let defaultInstance = _StorageClass()
private init() {}
init(copying source: _StorageClass) {
_type = source._type
_senderCertificate = source._senderCertificate
_content = source._content
}
}
fileprivate mutating func _uniqueStorage() -> _StorageClass {
if !isKnownUniquelyReferenced(&_storage) {
_storage = _StorageClass(copying: _storage)
}
return _storage
}
mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {
_ = _uniqueStorage()
try withExtendedLifetime(_storage) { (_storage: _StorageClass) in
while let fieldNumber = try decoder.nextFieldNumber() {
switch fieldNumber {
case 1: try decoder.decodeSingularEnumField(value: &_storage._type)
case 2: try decoder.decodeSingularMessageField(value: &_storage._senderCertificate)
case 3: try decoder.decodeSingularBytesField(value: &_storage._content)
default: break
}
}
}
}
func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {
try withExtendedLifetime(_storage) { (_storage: _StorageClass) in
if let v = _storage._type {
try visitor.visitSingularEnumField(value: v, fieldNumber: 1)
}
if let v = _storage._senderCertificate {
try visitor.visitSingularMessageField(value: v, fieldNumber: 2)
}
if let v = _storage._content {
try visitor.visitSingularBytesField(value: v, fieldNumber: 3)
}
}
try unknownFields.traverse(visitor: &visitor)
}
func _protobuf_generated_isEqualTo(other: SMKProtos_UnidentifiedSenderMessage.Message) -> Bool {
if _storage !== other._storage {
let storagesAreEqual: Bool = withExtendedLifetime((_storage, other._storage)) { (_args: (_StorageClass, _StorageClass)) in
let _storage = _args.0
let other_storage = _args.1
if _storage._type != other_storage._type {return false}
if _storage._senderCertificate != other_storage._senderCertificate {return false}
if _storage._content != other_storage._content {return false}
return true
}
if !storagesAreEqual {return false}
}
if unknownFields != other.unknownFields {return false}
return true
}
}
extension SMKProtos_UnidentifiedSenderMessage.Message.TypeEnum: SwiftProtobuf._ProtoNameProviding {
static let _protobuf_nameMap: SwiftProtobuf._NameMap = [
1: .same(proto: "PREKEY_MESSAGE"),
2: .same(proto: "MESSAGE"),
]
}

725
SignalMetadataKit/src/Generated/SMKProto.swift Normal file
View File

@ -0,0 +1,725 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// WARNING: This code is generated. Only edit within the markers.
public enum SMKProtoError: Error {
case invalidProtobuf(description: String)
}
// MARK: - SMKProtoServerCertificateCertificate
@objc public class SMKProtoServerCertificateCertificate: NSObject {
// MARK: - SMKProtoServerCertificateCertificateBuilder
@objc public class func builder() -> SMKProtoServerCertificateCertificateBuilder {
return SMKProtoServerCertificateCertificateBuilder()
}
@objc public class SMKProtoServerCertificateCertificateBuilder: NSObject {
private var proto = SMKProtos_ServerCertificate.Certificate()
@objc public override init() {}
// Initializer for required fields
@objc public init(id: UInt32, key: Data) {
super.init()
setId(id)
setKey(key)
}
@objc public func setId(_ valueParam: UInt32) {
proto.id = valueParam
}
@objc public func setKey(_ valueParam: Data) {
proto.key = valueParam
}
@objc public func build() throws -> SMKProtoServerCertificateCertificate {
return try SMKProtoServerCertificateCertificate.parseProto(proto)
}
@objc public func buildSerializedData() throws -> Data {
return try SMKProtoServerCertificateCertificate.parseProto(proto).serializedData()
}
}
fileprivate let proto: SMKProtos_ServerCertificate.Certificate
@objc public let id: UInt32
@objc public let key: Data
private init(proto: SMKProtos_ServerCertificate.Certificate,
id: UInt32,
key: Data) {
self.proto = proto
self.id = id
self.key = key
}
@objc
public func serializedData() throws -> Data {
return try self.proto.serializedData()
}
@objc public class func parseData(_ serializedData: Data) throws -> SMKProtoServerCertificateCertificate {
let proto = try SMKProtos_ServerCertificate.Certificate(serializedData: serializedData)
return try parseProto(proto)
}
fileprivate class func parseProto(_ proto: SMKProtos_ServerCertificate.Certificate) throws -> SMKProtoServerCertificateCertificate {
guard proto.hasID else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: id")
}
let id = proto.id
guard proto.hasKey else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: key")
}
let key = proto.key
// MARK: - Begin Validation Logic for SMKProtoServerCertificateCertificate -
// MARK: - End Validation Logic for SMKProtoServerCertificateCertificate -
let result = SMKProtoServerCertificateCertificate(proto: proto,
id: id,
key: key)
return result
}
}
#if DEBUG
extension SMKProtoServerCertificateCertificate {
@objc public func serializedDataIgnoringErrors() -> Data? {
return try! self.serializedData()
}
}
extension SMKProtoServerCertificateCertificate.SMKProtoServerCertificateCertificateBuilder {
@objc public func buildIgnoringErrors() -> SMKProtoServerCertificateCertificate? {
return try! self.build()
}
}
#endif
// MARK: - SMKProtoServerCertificate
@objc public class SMKProtoServerCertificate: NSObject {
// MARK: - SMKProtoServerCertificateBuilder
@objc public class func builder() -> SMKProtoServerCertificateBuilder {
return SMKProtoServerCertificateBuilder()
}
@objc public class SMKProtoServerCertificateBuilder: NSObject {
private var proto = SMKProtos_ServerCertificate()
@objc public override init() {}
// Initializer for required fields
@objc public init(certificate: Data, signature: Data) {
super.init()
setCertificate(certificate)
setSignature(signature)
}
@objc public func setCertificate(_ valueParam: Data) {
proto.certificate = valueParam
}
@objc public func setSignature(_ valueParam: Data) {
proto.signature = valueParam
}
@objc public func build() throws -> SMKProtoServerCertificate {
return try SMKProtoServerCertificate.parseProto(proto)
}
@objc public func buildSerializedData() throws -> Data {
return try SMKProtoServerCertificate.parseProto(proto).serializedData()
}
}
fileprivate let proto: SMKProtos_ServerCertificate
@objc public let certificate: Data
@objc public let signature: Data
private init(proto: SMKProtos_ServerCertificate,
certificate: Data,
signature: Data) {
self.proto = proto
self.certificate = certificate
self.signature = signature
}
@objc
public func serializedData() throws -> Data {
return try self.proto.serializedData()
}
@objc public class func parseData(_ serializedData: Data) throws -> SMKProtoServerCertificate {
let proto = try SMKProtos_ServerCertificate(serializedData: serializedData)
return try parseProto(proto)
}
fileprivate class func parseProto(_ proto: SMKProtos_ServerCertificate) throws -> SMKProtoServerCertificate {
guard proto.hasCertificate else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: certificate")
}
let certificate = proto.certificate
guard proto.hasSignature else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: signature")
}
let signature = proto.signature
// MARK: - Begin Validation Logic for SMKProtoServerCertificate -
// MARK: - End Validation Logic for SMKProtoServerCertificate -
let result = SMKProtoServerCertificate(proto: proto,
certificate: certificate,
signature: signature)
return result
}
}
#if DEBUG
extension SMKProtoServerCertificate {
@objc public func serializedDataIgnoringErrors() -> Data? {
return try! self.serializedData()
}
}
extension SMKProtoServerCertificate.SMKProtoServerCertificateBuilder {
@objc public func buildIgnoringErrors() -> SMKProtoServerCertificate? {
return try! self.build()
}
}
#endif
// MARK: - SMKProtoSenderCertificateCertificate
@objc public class SMKProtoSenderCertificateCertificate: NSObject {
// MARK: - SMKProtoSenderCertificateCertificateBuilder
@objc public class func builder() -> SMKProtoSenderCertificateCertificateBuilder {
return SMKProtoSenderCertificateCertificateBuilder()
}
@objc public class SMKProtoSenderCertificateCertificateBuilder: NSObject {
private var proto = SMKProtos_SenderCertificate.Certificate()
@objc public override init() {}
// Initializer for required fields
@objc public init(sender: String, senderDevice: UInt32, expires: UInt64, identityKey: Data, signer: SMKProtoServerCertificate) {
super.init()
setSender(sender)
setSenderDevice(senderDevice)
setExpires(expires)
setIdentityKey(identityKey)
setSigner(signer)
}
@objc public func setSender(_ valueParam: String) {
proto.sender = valueParam
}
@objc public func setSenderDevice(_ valueParam: UInt32) {
proto.senderDevice = valueParam
}
@objc public func setExpires(_ valueParam: UInt64) {
proto.expires = valueParam
}
@objc public func setIdentityKey(_ valueParam: Data) {
proto.identityKey = valueParam
}
@objc public func setSigner(_ valueParam: SMKProtoServerCertificate) {
proto.signer = valueParam.proto
}
@objc public func build() throws -> SMKProtoSenderCertificateCertificate {
return try SMKProtoSenderCertificateCertificate.parseProto(proto)
}
@objc public func buildSerializedData() throws -> Data {
return try SMKProtoSenderCertificateCertificate.parseProto(proto).serializedData()
}
}
fileprivate let proto: SMKProtos_SenderCertificate.Certificate
@objc public let sender: String
@objc public let senderDevice: UInt32
@objc public let expires: UInt64
@objc public let identityKey: Data
@objc public let signer: SMKProtoServerCertificate
private init(proto: SMKProtos_SenderCertificate.Certificate,
sender: String,
senderDevice: UInt32,
expires: UInt64,
identityKey: Data,
signer: SMKProtoServerCertificate) {
self.proto = proto
self.sender = sender
self.senderDevice = senderDevice
self.expires = expires
self.identityKey = identityKey
self.signer = signer
}
@objc
public func serializedData() throws -> Data {
return try self.proto.serializedData()
}
@objc public class func parseData(_ serializedData: Data) throws -> SMKProtoSenderCertificateCertificate {
let proto = try SMKProtos_SenderCertificate.Certificate(serializedData: serializedData)
return try parseProto(proto)
}
fileprivate class func parseProto(_ proto: SMKProtos_SenderCertificate.Certificate) throws -> SMKProtoSenderCertificateCertificate {
guard proto.hasSender else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: sender")
}
let sender = proto.sender
guard proto.hasSenderDevice else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: senderDevice")
}
let senderDevice = proto.senderDevice
guard proto.hasExpires else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: expires")
}
let expires = proto.expires
guard proto.hasIdentityKey else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: identityKey")
}
let identityKey = proto.identityKey
guard proto.hasSigner else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: signer")
}
let signer = try SMKProtoServerCertificate.parseProto(proto.signer)
// MARK: - Begin Validation Logic for SMKProtoSenderCertificateCertificate -
// MARK: - End Validation Logic for SMKProtoSenderCertificateCertificate -
let result = SMKProtoSenderCertificateCertificate(proto: proto,
sender: sender,
senderDevice: senderDevice,
expires: expires,
identityKey: identityKey,
signer: signer)
return result
}
}
#if DEBUG
extension SMKProtoSenderCertificateCertificate {
@objc public func serializedDataIgnoringErrors() -> Data? {
return try! self.serializedData()
}
}
extension SMKProtoSenderCertificateCertificate.SMKProtoSenderCertificateCertificateBuilder {
@objc public func buildIgnoringErrors() -> SMKProtoSenderCertificateCertificate? {
return try! self.build()
}
}
#endif
// MARK: - SMKProtoSenderCertificate
@objc public class SMKProtoSenderCertificate: NSObject {
// MARK: - SMKProtoSenderCertificateBuilder
@objc public class func builder() -> SMKProtoSenderCertificateBuilder {
return SMKProtoSenderCertificateBuilder()
}
@objc public class SMKProtoSenderCertificateBuilder: NSObject {
private var proto = SMKProtos_SenderCertificate()
@objc public override init() {}
// Initializer for required fields
@objc public init(certificate: Data, signature: Data) {
super.init()
setCertificate(certificate)
setSignature(signature)
}
@objc public func setCertificate(_ valueParam: Data) {
proto.certificate = valueParam
}
@objc public func setSignature(_ valueParam: Data) {
proto.signature = valueParam
}
@objc public func build() throws -> SMKProtoSenderCertificate {
return try SMKProtoSenderCertificate.parseProto(proto)
}
@objc public func buildSerializedData() throws -> Data {
return try SMKProtoSenderCertificate.parseProto(proto).serializedData()
}
}
fileprivate let proto: SMKProtos_SenderCertificate
@objc public let certificate: Data
@objc public let signature: Data
private init(proto: SMKProtos_SenderCertificate,
certificate: Data,
signature: Data) {
self.proto = proto
self.certificate = certificate
self.signature = signature
}
@objc
public func serializedData() throws -> Data {
return try self.proto.serializedData()
}
@objc public class func parseData(_ serializedData: Data) throws -> SMKProtoSenderCertificate {
let proto = try SMKProtos_SenderCertificate(serializedData: serializedData)
return try parseProto(proto)
}
fileprivate class func parseProto(_ proto: SMKProtos_SenderCertificate) throws -> SMKProtoSenderCertificate {
guard proto.hasCertificate else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: certificate")
}
let certificate = proto.certificate
guard proto.hasSignature else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: signature")
}
let signature = proto.signature
// MARK: - Begin Validation Logic for SMKProtoSenderCertificate -
// MARK: - End Validation Logic for SMKProtoSenderCertificate -
let result = SMKProtoSenderCertificate(proto: proto,
certificate: certificate,
signature: signature)
return result
}
}
#if DEBUG
extension SMKProtoSenderCertificate {
@objc public func serializedDataIgnoringErrors() -> Data? {
return try! self.serializedData()
}
}
extension SMKProtoSenderCertificate.SMKProtoSenderCertificateBuilder {
@objc public func buildIgnoringErrors() -> SMKProtoSenderCertificate? {
return try! self.build()
}
}
#endif
// MARK: - SMKProtoUnidentifiedSenderMessageMessage
@objc public class SMKProtoUnidentifiedSenderMessageMessage: NSObject {
// MARK: - SMKProtoUnidentifiedSenderMessageMessageType
@objc public enum SMKProtoUnidentifiedSenderMessageMessageType: Int32 {
case prekeyMessage = 1
case message = 2
}
private class func SMKProtoUnidentifiedSenderMessageMessageTypeWrap(_ value: SMKProtos_UnidentifiedSenderMessage.Message.TypeEnum) -> SMKProtoUnidentifiedSenderMessageMessageType {
switch value {
case .prekeyMessage: return .prekeyMessage
case .message: return .message
}
}
private class func SMKProtoUnidentifiedSenderMessageMessageTypeUnwrap(_ value: SMKProtoUnidentifiedSenderMessageMessageType) -> SMKProtos_UnidentifiedSenderMessage.Message.TypeEnum {
switch value {
case .prekeyMessage: return .prekeyMessage
case .message: return .message
}
}
// MARK: - SMKProtoUnidentifiedSenderMessageMessageBuilder
@objc public class func builder() -> SMKProtoUnidentifiedSenderMessageMessageBuilder {
return SMKProtoUnidentifiedSenderMessageMessageBuilder()
}
@objc public class SMKProtoUnidentifiedSenderMessageMessageBuilder: NSObject {
private var proto = SMKProtos_UnidentifiedSenderMessage.Message()
@objc public override init() {}
// Initializer for required fields
@objc public init(type: SMKProtoUnidentifiedSenderMessageMessageType, senderCertificate: SMKProtoSenderCertificate, content: Data) {
super.init()
setType(type)
setSenderCertificate(senderCertificate)
setContent(content)
}
@objc public func setType(_ valueParam: SMKProtoUnidentifiedSenderMessageMessageType) {
proto.type = SMKProtoUnidentifiedSenderMessageMessageTypeUnwrap(valueParam)
}
@objc public func setSenderCertificate(_ valueParam: SMKProtoSenderCertificate) {
proto.senderCertificate = valueParam.proto
}
@objc public func setContent(_ valueParam: Data) {
proto.content = valueParam
}
@objc public func build() throws -> SMKProtoUnidentifiedSenderMessageMessage {
return try SMKProtoUnidentifiedSenderMessageMessage.parseProto(proto)
}
@objc public func buildSerializedData() throws -> Data {
return try SMKProtoUnidentifiedSenderMessageMessage.parseProto(proto).serializedData()
}
}
fileprivate let proto: SMKProtos_UnidentifiedSenderMessage.Message
@objc public let type: SMKProtoUnidentifiedSenderMessageMessageType
@objc public let senderCertificate: SMKProtoSenderCertificate
@objc public let content: Data
private init(proto: SMKProtos_UnidentifiedSenderMessage.Message,
type: SMKProtoUnidentifiedSenderMessageMessageType,
senderCertificate: SMKProtoSenderCertificate,
content: Data) {
self.proto = proto
self.type = type
self.senderCertificate = senderCertificate
self.content = content
}
@objc
public func serializedData() throws -> Data {
return try self.proto.serializedData()
}
@objc public class func parseData(_ serializedData: Data) throws -> SMKProtoUnidentifiedSenderMessageMessage {
let proto = try SMKProtos_UnidentifiedSenderMessage.Message(serializedData: serializedData)
return try parseProto(proto)
}
fileprivate class func parseProto(_ proto: SMKProtos_UnidentifiedSenderMessage.Message) throws -> SMKProtoUnidentifiedSenderMessageMessage {
guard proto.hasType else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: type")
}
let type = SMKProtoUnidentifiedSenderMessageMessageTypeWrap(proto.type)
guard proto.hasSenderCertificate else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: senderCertificate")
}
let senderCertificate = try SMKProtoSenderCertificate.parseProto(proto.senderCertificate)
guard proto.hasContent else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: content")
}
let content = proto.content
// MARK: - Begin Validation Logic for SMKProtoUnidentifiedSenderMessageMessage -
// MARK: - End Validation Logic for SMKProtoUnidentifiedSenderMessageMessage -
let result = SMKProtoUnidentifiedSenderMessageMessage(proto: proto,
type: type,
senderCertificate: senderCertificate,
content: content)
return result
}
}
#if DEBUG
extension SMKProtoUnidentifiedSenderMessageMessage {
@objc public func serializedDataIgnoringErrors() -> Data? {
return try! self.serializedData()
}
}
extension SMKProtoUnidentifiedSenderMessageMessage.SMKProtoUnidentifiedSenderMessageMessageBuilder {
@objc public func buildIgnoringErrors() -> SMKProtoUnidentifiedSenderMessageMessage? {
return try! self.build()
}
}
#endif
// MARK: - SMKProtoUnidentifiedSenderMessage
@objc public class SMKProtoUnidentifiedSenderMessage: NSObject {
// MARK: - SMKProtoUnidentifiedSenderMessageBuilder
@objc public class func builder() -> SMKProtoUnidentifiedSenderMessageBuilder {
return SMKProtoUnidentifiedSenderMessageBuilder()
}
@objc public class SMKProtoUnidentifiedSenderMessageBuilder: NSObject {
private var proto = SMKProtos_UnidentifiedSenderMessage()
@objc public override init() {}
// Initializer for required fields
@objc public init(ephemeralPublic: Data, encryptedStatic: Data, encryptedMessage: Data) {
super.init()
setEphemeralPublic(ephemeralPublic)
setEncryptedStatic(encryptedStatic)
setEncryptedMessage(encryptedMessage)
}
@objc public func setEphemeralPublic(_ valueParam: Data) {
proto.ephemeralPublic = valueParam
}
@objc public func setEncryptedStatic(_ valueParam: Data) {
proto.encryptedStatic = valueParam
}
@objc public func setEncryptedMessage(_ valueParam: Data) {
proto.encryptedMessage = valueParam
}
@objc public func build() throws -> SMKProtoUnidentifiedSenderMessage {
return try SMKProtoUnidentifiedSenderMessage.parseProto(proto)
}
@objc public func buildSerializedData() throws -> Data {
return try SMKProtoUnidentifiedSenderMessage.parseProto(proto).serializedData()
}
}
fileprivate let proto: SMKProtos_UnidentifiedSenderMessage
@objc public let ephemeralPublic: Data
@objc public let encryptedStatic: Data
@objc public let encryptedMessage: Data
private init(proto: SMKProtos_UnidentifiedSenderMessage,
ephemeralPublic: Data,
encryptedStatic: Data,
encryptedMessage: Data) {
self.proto = proto
self.ephemeralPublic = ephemeralPublic
self.encryptedStatic = encryptedStatic
self.encryptedMessage = encryptedMessage
}
@objc
public func serializedData() throws -> Data {
return try self.proto.serializedData()
}
@objc public class func parseData(_ serializedData: Data) throws -> SMKProtoUnidentifiedSenderMessage {
let proto = try SMKProtos_UnidentifiedSenderMessage(serializedData: serializedData)
return try parseProto(proto)
}
fileprivate class func parseProto(_ proto: SMKProtos_UnidentifiedSenderMessage) throws -> SMKProtoUnidentifiedSenderMessage {
guard proto.hasEphemeralPublic else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: ephemeralPublic")
}
let ephemeralPublic = proto.ephemeralPublic
guard proto.hasEncryptedStatic else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: encryptedStatic")
}
let encryptedStatic = proto.encryptedStatic
guard proto.hasEncryptedMessage else {
throw SMKProtoError.invalidProtobuf(description: "\(logTag) missing required field: encryptedMessage")
}
let encryptedMessage = proto.encryptedMessage
// MARK: - Begin Validation Logic for SMKProtoUnidentifiedSenderMessage -
// MARK: - End Validation Logic for SMKProtoUnidentifiedSenderMessage -
let result = SMKProtoUnidentifiedSenderMessage(proto: proto,
ephemeralPublic: ephemeralPublic,
encryptedStatic: encryptedStatic,
encryptedMessage: encryptedMessage)
return result
}
}
#if DEBUG
extension SMKProtoUnidentifiedSenderMessage {
@objc public func serializedDataIgnoringErrors() -> Data? {
return try! self.serializedData()
}
}
extension SMKProtoUnidentifiedSenderMessage.SMKProtoUnidentifiedSenderMessageBuilder {
@objc public func buildIgnoringErrors() -> SMKProtoUnidentifiedSenderMessage? {
return try! self.build()
}
}
#endif

9
SignalMetadataKit/src/SMK-Bridging-Header.h Normal file
View File

@ -0,0 +1,9 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
#import <AxolotlKit/AxolotlStore.h>
#import <Curve25519Kit/Curve25519.h>
#import <Foundation/Foundation.h>
#import <SignalCoreKit/NSObject+OWS.h>
#import <SignalCoreKit/OWSAsserts.h>

107
SignalMetadataKit/src/SMKCertificateValidator.swift Normal file
View File

@ -0,0 +1,107 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
public enum SMKCertificateError: Error {
case invalidCertificate(description: String)
}
@objc public protocol SMKCertificateValidator: class {
@objc func validate(senderCertificate: SMKSenderCertificate, validationTime: UInt64) throws
@objc func validate(serverCertificate: SMKServerCertificate) throws
}
// See: https://github.com/signalapp/libsignal-metadata-java/blob/master/java/src/main/java/org/signal/libsignal/metadata/certificate/CertificateValidator.java
//public class CertificateValidator {
@objc public class SMKCertificateDefaultValidator: NSObject, SMKCertificateValidator {
// @SuppressWarnings("MismatchedQueryAndUpdateOfCollection")
// private static final Set<Integer> REVOKED = new HashSet<Integer>() {{
//
// }};
private static let kRevokedCertificateIds = Set<UInt32>()
//
// private final ECPublicKey trustRoot;
private let trustRoot: ECPublicKey
// public CertificateValidator(ECPublicKey trustRoot) {
// this.trustRoot = trustRoot;
// }
@objc public init(trustRoot: ECPublicKey ) {
self.trustRoot = trustRoot
}
// public void validate(SenderCertificate certificate, long validationTime) throws InvalidCertificateException {
@objc public func validate(senderCertificate: SMKSenderCertificate, validationTime: UInt64) throws {
// try {
// ServerCertificate serverCertificate = certificate.getSigner();
let serverCertificate = senderCertificate.signer
// validate(serverCertificate);
try validate(serverCertificate: serverCertificate)
// if (!Curve.verifySignature(serverCertificate.getKey(), certificate.getCertificate(), certificate.getSignature())) {
// throw new InvalidCertificateException("Signature failed");
// }
let certificateData = try senderCertificate.toProto().certificate
guard Ed25519.verifySignature(senderCertificate.signatureData,
publicKey: serverCertificate.key.keyData,
data: certificateData) else {
Logger.error("Sender certificate signature verification failed.")
let error = SMKCertificateError.invalidCertificate(description: "Sender certificate signature verification failed.")
Logger.error("\(error)")
throw error
}
// if (validationTime > certificate.getExpiration()) {
// throw new InvalidCertificateException("Certificate is expired");
// }
guard validationTime <= senderCertificate.expirationTimestamp else {
let error = SMKCertificateError.invalidCertificate(description: "Certficate is expired.")
Logger.error("\(error)")
throw error
}
// } catch (InvalidKeyException e) {
// throw new InvalidCertificateException(e);
// }
}
// // VisibleForTesting
// void validate(ServerCertificate certificate) throws InvalidCertificateException {
@objc public func validate(serverCertificate: SMKServerCertificate) throws {
// try {
// if (!Curve.verifySignature(trustRoot, certificate.getCertificate(), certificate.getSignature())) {
// throw new InvalidCertificateException("Signature failed");
// }
let certificateBuilder = SMKProtoServerCertificateCertificate.builder()
certificateBuilder.setId(serverCertificate.keyId)
certificateBuilder.setKey(serverCertificate.key.serialized)
let certificateData = try certificateBuilder.build().serializedData()
// let certificateData = try serverCertificate.toProto().certificate
guard Ed25519.verifySignature(serverCertificate.signatureData,
publicKey: trustRoot.keyData,
data: certificateData) else {
let error = SMKCertificateError.invalidCertificate(description: "Server certificate signature verification failed.")
Logger.error("\(error)")
throw error
}
// if (REVOKED.contains(certificate.getKeyId())) {
// throw new InvalidCertificateException("Server certificate has been revoked");
// }
guard !SMKCertificateDefaultValidator.kRevokedCertificateIds.contains(serverCertificate.keyId) else {
let error = SMKCertificateError.invalidCertificate(description: "Revoked certificate.")
Logger.error("\(error)")
throw error
}
// } catch (InvalidKeyException e) {
// throw new InvalidCertificateException(e);
// }
}
}

9
SignalMetadataKit/src/SMKError.swift Normal file
View File

@ -0,0 +1,9 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
public enum SMKError: Error {
case assertionError(description: String)
}

6
SignalMetadataKit/src/SMKImports.h Normal file
View File

@ -0,0 +1,6 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <HKDFKit/HKDFKit.h>

529
SignalMetadataKit/src/SMKSecretSessionCipher.swift Normal file
View File

@ -0,0 +1,529 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// See:
// https://github.com/signalapp/libsignal-metadata-java/blob/master/java/src/main/java/org/signal/libsignal/metadata/SecretSessionCipher.java
public extension ECKeyPair {
// TODO: Rename to publicKey(), rename existing publicKey() method to publicKeyData().
func ecPublicKey() throws -> ECPublicKey {
guard publicKey.count == ECCKeyLength else {
throw SMKError.assertionError(description: "\(logTag) public key has invalid length")
}
// NOTE: we don't use ECPublicKey(serializedKeyData:) since the
// key data should not have a type byte.
return try ECPublicKey(keyData: publicKey)
}
// TODO: Rename to privateKey(), rename existing privateKey() method to privateKeyData().
func ecPrivateKey() throws -> ECPrivateKey {
guard privateKey.count == ECCKeyLength else {
throw SMKError.assertionError(description: "\(logTag) private key has invalid length")
}
return try ECPrivateKey(keyData: privateKey)
}
}
// MARK: -
private class SMKSecretKeySpec: NSObject {
@objc public let keyData: Data
@objc public let algorithm: String
init(keyData: Data, algorithm: String) {
self.keyData = keyData
self.algorithm = algorithm
}
}
// MARK: -
private class SMKEphemeralKeys: NSObject {
@objc public let chainKey: Data
@objc public let cipherKey: SMKSecretKeySpec
@objc public let macKey: SMKSecretKeySpec
init(chainKey: Data, cipherKey: Data, macKey: Data) {
self.chainKey = chainKey
self.cipherKey = SMKSecretKeySpec(keyData: cipherKey, algorithm: "AES")
self.macKey = SMKSecretKeySpec(keyData: macKey, algorithm: "HmacSHA256")
}
}
// MARK: -
private class SMKStaticKeys: NSObject {
@objc public let cipherKey: SMKSecretKeySpec
@objc public let macKey: SMKSecretKeySpec
init(cipherKey: Data, macKey: Data) {
self.cipherKey = SMKSecretKeySpec(keyData: cipherKey, algorithm: "AES")
self.macKey = SMKSecretKeySpec(keyData: macKey, algorithm: "HmacSHA256")
}
}
// MARK: -
@objc public class SMKSecretSessionCipher: NSObject {
private let kUDPrefixString = "UnidentifiedDelivery"
private let kSMKSecretSessionCipherMacLength: UInt = 10
private let sessionStore: SessionStore
private let preKeyStore: PreKeyStore
private let signedPreKeyStore: SignedPreKeyStore
private let identityStore: IdentityKeyStore
// public SecretSessionCipher(SignalProtocolStore signalProtocolStore) {
@objc public init(sessionStore: SessionStore,
preKeyStore: PreKeyStore,
signedPreKeyStore: SignedPreKeyStore,
identityStore: IdentityKeyStore) throws {
self.sessionStore = sessionStore
self.preKeyStore = preKeyStore
self.signedPreKeyStore = signedPreKeyStore
self.identityStore = identityStore
}
// MARK: - Public
// public byte[] encrypt(SignalProtocolAddress destinationAddress, SenderCertificate senderCertificate, byte[]
// paddedPlaintext)
@objc public func encryptMessage(recipientId: String,
deviceId: Int32,
paddedPlaintext: Data,
senderCertificate: SMKSenderCertificate,
protocolContext: Any?) throws -> Data {
guard recipientId.count > 0 else {
throw SMKError.assertionError(description: "\(SMKSecretSessionCipher.logTag) invalid recipientId")
}
guard deviceId > 0 else {
throw SMKError.assertionError(description: "\(SMKSecretSessionCipher.logTag) invalid deviceId")
}
// CiphertextMessage message = new SessionCipher(signalProtocolStore, destinationAddress).encrypt(paddedPlaintext);
let cipher = SessionCipher(sessionStore: sessionStore,
preKeyStore: preKeyStore,
signedPreKeyStore: signedPreKeyStore,
identityKeyStore: identityStore,
recipientId: recipientId,
deviceId: deviceId)
// CiphertextMessage message = new SessionCipher(signalProtocolStore, destinationAddress).encrypt(paddedPlaintext);
let encryptedMessage = cipher.encryptMessage(paddedPlaintext,
protocolContext: protocolContext)
guard let encryptedMessageData = encryptedMessage.serialized() else {
throw SMKError.assertionError(description: "\(logTag) Could not serialize encrypted message.")
}
// IdentityKeyPair ourIdentity = signalProtocolStore.getIdentityKeyPair();
guard let ourIdentityKeyPair = identityStore.identityKeyPair(protocolContext) else {
throw SMKError.assertionError(description: "\(logTag) Missing our identity key pair.")
}
// ECPublicKey theirIdentity = signalProtocolStore.getIdentity(destinationAddress).getPublicKey();
guard let theirIdentityKeyData = identityStore.identityKey(forRecipientId: recipientId, protocolContext: protocolContext) else {
throw SMKError.assertionError(description: "\(logTag) Missing their public identity key.")
}
// NOTE: we don't use ECPublicKey(serializedKeyData) since the
// key data should not have a type byte.
let theirIdentityKey = try ECPublicKey(keyData: theirIdentityKeyData)
// ECKeyPair ephemeral = Curve.generateKeyPair();
let ephemeral = Curve25519.generateKeyPair()
// byte[] ephemeralSalt = ByteUtil.combine("UnidentifiedDelivery".getBytes(), theirIdentity.serialize(),
// ephemeral.getPublicKey().serialize());
guard let prefixData = kUDPrefixString.data(using: String.Encoding.utf8) else {
throw SMKError.assertionError(description: "\(logTag) Could not encode prefix.")
}
let ephemeralSalt = NSData.join([
prefixData,
theirIdentityKey.serialized,
try ephemeral.ecPublicKey().serialized
])
// EphemeralKeys ephemeralKeys = calculateEphemeralKeys(theirIdentity, ephemeral.getPrivateKey(), ephemeralSalt);
let ephemeralKeys = try calculateEphemeralKeys(ephemeralPublicKey: theirIdentityKey,
ephemeralPrivateKey: ephemeral.ecPrivateKey(),
salt: ephemeralSalt)
// byte[] staticKeyCiphertext = encrypt(ephemeralKeys.cipherKey, ephemeralKeys.macKey,
// ourIdentity.getPublicKey().getPublicKey().serialize());
let staticKeyCipherData = try encrypt(cipherKey: ephemeralKeys.cipherKey,
macKey: ephemeralKeys.macKey,
plaintextData: ourIdentityKeyPair.ecPublicKey().serialized)
// byte[] staticSalt = ByteUtil.combine(ephemeralKeys.chainKey, staticKeyCiphertext);
let staticSalt = NSData.join([
ephemeralKeys.chainKey,
staticKeyCipherData
])
// StaticKeys staticKeys = calculateStaticKeys(theirIdentity, ourIdentity.getPrivateKey(), staticSalt);
let staticKeys = try calculateStaticKeys(staticPublicKey: theirIdentityKey,
staticPrivateKey: ourIdentityKeyPair.ecPrivateKey(),
salt: staticSalt)
// UnidentifiedSenderMessageContent content = new UnidentifiedSenderMessageContent(message.getType(),
// senderCertificate, message.serialize());
var messageType: SMKMessageType
switch encryptedMessage.cipherMessageType {
case .prekey:
messageType = .prekey
case .whisper:
messageType = .whisper
default:
throw SMKError.assertionError(description: "\(logTag) Unknown cipher message type.")
}
let messageContent = SMKUnidentifiedSenderMessageContent(messageType: messageType,
senderCertificate: senderCertificate,
contentData: encryptedMessageData)
// byte[] messageBytes = encrypt(staticKeys.cipherKey, staticKeys.macKey, content.getSerialized());
let messageData = try encrypt(cipherKey: staticKeys.cipherKey,
macKey: staticKeys.macKey,
plaintextData: try messageContent.serialized())
// return new UnidentifiedSenderMessage(ephemeral.getPublicKey(), staticKeyCiphertext,
// messageBytes).getSerialized();
let message = SMKUnidentifiedSenderMessage(ephemeralKey: try ephemeral.ecPublicKey(),
encryptedStatic: staticKeyCipherData,
encryptedMessage: messageData)
return try message.serialized()
}
// public Pair<SignalProtocolAddress, byte[]> decrypt(CertificateValidator validator, byte[] ciphertext, long
/// timestamp) /throws /InvalidMetadataMessageException, InvalidMetadataVersionException,
// ProtocolInvalidMessageException, ProtocolInvalidKeyException,
// ProtocolNoSessionException, ProtocolLegacyMessageException,
// ProtocolInvalidVersionException, ProtocolDuplicateMessageException,
// ProtocolInvalidKeyIdException, ProtocolUntrustedIdentityException
public func decryptMessage(certificateValidator: SMKCertificateValidator,
cipherTextData: Data,
timestamp: UInt64,
protocolContext: Any?) throws -> (senderRecipientId: String,
senderDeviceId: Int,
paddedPayload: Data) {
guard timestamp > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid timestamp")
}
// IdentityKeyPair ourIdentity = signalProtocolStore.getIdentityKeyPair();
guard let ourIdentityKeyPair = identityStore.identityKeyPair(protocolContext) else {
throw SMKError.assertionError(description: "\(logTag) Missing our identity key pair.")
}
// UnidentifiedSenderMessage wrapper = new UnidentifiedSenderMessage(ciphertext);
let wrapper = try SMKUnidentifiedSenderMessage.parse(dataAndPrefix: cipherTextData)
// byte[] ephemeralSalt = ByteUtil.combine("UnidentifiedDelivery".getBytes(),
// ourIdentity.getPublicKey().getPublicKey().serialize(), wrapper.getEphemeral().serialize());
guard let prefixData = kUDPrefixString.data(using: String.Encoding.utf8) else {
throw SMKError.assertionError(description: "\(logTag) Could not encode prefix.")
}
let ephemeralSalt = NSData.join([
prefixData,
try ourIdentityKeyPair.ecPublicKey().serialized,
wrapper.ephemeralKey.serialized
])
// EphemeralKeys ephemeralKeys = calculateEphemeralKeys(wrapper.getEphemeral(), ourIdentity.getPrivateKey(),
// ephemeralSalt);
let ephemeralKeys = try calculateEphemeralKeys(ephemeralPublicKey: wrapper.ephemeralKey,
ephemeralPrivateKey: ourIdentityKeyPair.ecPrivateKey(),
salt: ephemeralSalt)
// byte[] staticKeyBytes = decrypt(ephemeralKeys.cipherKey, ephemeralKeys.macKey, wrapper.getEncryptedStatic());
let staticKeyBytes = try decrypt(cipherKey: ephemeralKeys.cipherKey,
macKey: ephemeralKeys.macKey,
cipherTextWithMac: wrapper.encryptedStatic)
// ECPublicKey staticKey = Curve.decodePoint(staticKeyBytes, 0);
let staticKey = try ECPublicKey(serializedKeyData: staticKeyBytes)
// byte[] staticSalt = ByteUtil.combine(ephemeralKeys.chainKey, wrapper.getEncryptedStatic());
let staticSalt = NSData.join([
ephemeralKeys.chainKey,
wrapper.encryptedStatic
])
// StaticKeys staticKeys = calculateStaticKeys(staticKey, ourIdentity.getPrivateKey(), staticSalt);
let staticKeys = try calculateStaticKeys(staticPublicKey: staticKey,
staticPrivateKey: ourIdentityKeyPair.ecPrivateKey(),
salt: staticSalt)
// byte[] messageBytes = decrypt(staticKeys.cipherKey, staticKeys.macKey, wrapper.getEncryptedMessage());
let messageBytes = try decrypt(cipherKey: staticKeys.cipherKey,
macKey: staticKeys.macKey,
cipherTextWithMac: wrapper.encryptedMessage)
// content = new UnidentifiedSenderMessageContent(messageBytes);
let messageContent = try SMKUnidentifiedSenderMessageContent.parse(data: messageBytes)
// validator.validate(content.getSenderCertificate(), timestamp);
try certificateValidator.validate(senderCertificate: messageContent.senderCertificate,
validationTime: timestamp)
// if (!MessageDigest.isEqual(content.getSenderCertificate().getKey().serialize(), staticKeyBytes)) {
// throw new InvalidKeyException("Sender's certificate key does not match key used in message");
// }
//
// NOTE: Constant time comparison.
guard messageContent.senderCertificate.key.serialized.ows_constantTimeIsEqual(to: staticKeyBytes) else {
throw SMKError.assertionError(description: "\(logTag) Sender's certificate key does not match key used in message.")
}
let paddedMessagePlaintext = try decrypt(messageContent: messageContent, protocolContext: protocolContext)
// return new Pair<>(new SignalProtocolAddress(content.getSenderCertificate().getSender(),
// content.getSenderCertificate().getSenderDeviceId()),
// decrypt(content));
//
// NOTE: We use the sender properties from the sender certificate, not from this class' properties.
let senderRecipientId = messageContent.senderCertificate.senderRecipientId
let senderDeviceId = messageContent.senderCertificate.senderDeviceId
guard senderDeviceId >= 0 && senderDeviceId <= INT_MAX else {
throw SMKError.assertionError(description: "\(logTag) Invalid senderDeviceId.")
}
return (senderRecipientId: senderRecipientId, senderDeviceId: Int(senderDeviceId), paddedPayload: paddedMessagePlaintext)
}
// MARK: - Encrypt
// private EphemeralKeys calculateEphemeralKeys(ECPublicKey ephemeralPublic, ECPrivateKey ephemeralPrivate, byte[] salt)
// throws InvalidKeyException {
private func calculateEphemeralKeys(ephemeralPublicKey: ECPublicKey,
ephemeralPrivateKey: ECPrivateKey,
salt: Data) throws -> SMKEphemeralKeys {
guard ephemeralPublicKey.keyData.count > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid ephemeralPublicKey")
}
guard ephemeralPrivateKey.keyData.count > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid ephemeralPrivateKey")
}
guard salt.count > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid salt")
}
// byte[] ephemeralSecret = Curve.calculateAgreement(ephemeralPublic, ephemeralPrivate);
//
// See:
// https://github.com/signalapp/libsignal-protocol-java/blob/master/java/src/main/java/org/whispersystems/libsignal/ecc/Curve.java#L30
let ephemeralSecret = Curve25519.generateSharedSecret(fromPublicKey: ephemeralPublicKey.keyData, privateKey: ephemeralPrivateKey.keyData)
// byte[] ephemeralDerived = new HKDFv3().deriveSecrets(ephemeralSecret, salt, new byte[0], 96);
let kEphemeralDerivedLength: UInt = 96
let ephemeralDerived: Data =
HKDFKit.deriveKey(ephemeralSecret, info: Data(), salt: salt, outputSize: Int32(kEphemeralDerivedLength))
guard ephemeralDerived.count == kEphemeralDerivedLength else {
throw SMKError.assertionError(description: "\(logTag) derived ephemeral has unexpected length: \(ephemeralDerived.count).")
}
let ephemeralDerivedParser = SSKDataParser(data: ephemeralDerived)
let chainKey = try ephemeralDerivedParser.nextData(length: 32, name: "chain key")
let cipherKey = try ephemeralDerivedParser.nextData(length: 32, name: "cipher key")
let macKey = try ephemeralDerivedParser.nextData(length: 32, name: "mac key")
guard ephemeralDerivedParser.isEmpty else {
throw SMKError.assertionError(description: "\(logTag) could not parse derived ephemeral.")
}
return SMKEphemeralKeys(chainKey: chainKey, cipherKey: cipherKey, macKey: macKey)
}
// private StaticKeys calculateStaticKeys(ECPublicKey staticPublic, ECPrivateKey staticPrivate, byte[] salt) throws
// InvalidKeyException {
private func calculateStaticKeys(staticPublicKey: ECPublicKey,
staticPrivateKey: ECPrivateKey,
salt: Data) throws -> SMKStaticKeys {
guard staticPublicKey.keyData.count > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid staticPublicKey")
}
guard staticPrivateKey.keyData.count > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid staticPrivateKey")
}
guard salt.count > 0 else {
throw SMKError.assertionError(description: "\(logTag) invalid salt")
}
// byte[] staticSecret = Curve.calculateAgreement(staticPublic, staticPrivate);
//
// See:
// https://github.com/signalapp/libsignal-protocol-java/blob/master/java/src/main/java/org/whispersystems/libsignal/ecc/Curve.java#L30
let staticSecret = Curve25519.generateSharedSecret(fromPublicKey: staticPublicKey.keyData, privateKey: staticPrivateKey.keyData)
// byte[] staticDerived = new HKDFv3().deriveSecrets(staticSecret, salt, new byte[0], 96);
let kStaticDerivedLength: UInt = 96
let staticDerived: Data =
HKDFKit.deriveKey(staticSecret, info: Data(), salt: salt, outputSize: Int32(kStaticDerivedLength))
guard staticDerived.count == kStaticDerivedLength else {
throw SMKError.assertionError(description: "\(logTag) could not derive static.")
}
// byte[][] staticDerivedParts = ByteUtil.split(staticDerived, 32, 32, 32);
let staticDerivedParser = SSKDataParser(data: staticDerived)
_ = try staticDerivedParser.nextData(length: 32)
let cipherKey = try staticDerivedParser.nextData(length: 32)
let macKey = try staticDerivedParser.nextData(length: 32)
guard staticDerivedParser.isEmpty else {
throw SMKError.assertionError(description: "\(logTag) invalid derived static.")
}
// return new StaticKeys(staticDerivedParts[1], staticDerivedParts[2]);
return SMKStaticKeys(cipherKey: cipherKey, macKey: macKey)
}
// private byte[] encrypt(SecretKeySpec cipherKey, SecretKeySpec macKey, byte[] plaintext) {
private func encrypt(cipherKey: SMKSecretKeySpec,
macKey: SMKSecretKeySpec,
plaintextData: Data) throws -> Data {
// Cipher cipher = Cipher.getInstance("AES/CTR/NoPadding");
// cipher.init(Cipher.ENCRYPT_MODE, cipherKey, new IvParameterSpec(new byte[16]));
// byte[] ciphertext = cipher.doFinal(plaintext);
guard let aesKey = OWSAES256Key(data: cipherKey.keyData) else {
throw SMKError.assertionError(description: "\(logTag) Invalid encryption key.")
}
// NOTE: The IV is all zeroes. This is fine since we're using a unique key.
let initializationVector = Data(count: Int(kAES256CTR_IVLength))
guard let encryptionResult = Cryptography.encryptAESCTR(plaintextData: plaintextData, initializationVector: initializationVector, key: aesKey) else {
throw SMKError.assertionError(description: "\(logTag) Could not encrypt data.")
}
let cipherText = encryptionResult.ciphertext
// Mac mac = Mac.getInstance("HmacSHA256");
// mac.init(macKey);
//
// byte[] ourFullMac = mac.doFinal(ciphertext);
// byte[] ourMac = ByteUtil.trim(ourFullMac, 10);
guard let ourMac = Cryptography.truncatedSHA256HMAC(cipherText, withHMACKey: macKey.keyData, truncation: 10) else {
throw SMKError.assertionError(description: "\(logTag) Could not compute HmacSHA256.")
}
// return ByteUtil.combine(ciphertext, ourMac);
let result = NSData.join([
cipherText,
ourMac
])
return result
}
// MARK: - Decrypt
// private byte[] decrypt(UnidentifiedSenderMessageContent message)
// throws InvalidVersionException, InvalidMessageException, InvalidKeyException, DuplicateMessageException,
// InvalidKeyIdException, UntrustedIdentityException, LegacyMessageException, NoSessionException
private func decrypt(messageContent: SMKUnidentifiedSenderMessageContent,
protocolContext: Any?) throws -> Data {
// SignalProtocolAddress sender = new SignalProtocolAddress(message.getSenderCertificate().getSender(),
// message.getSenderCertificate().getSenderDeviceId());
//
// NOTE: We use the sender properties from the sender certificate, not from this class' properties.
let senderRecipientId = messageContent.senderCertificate.senderRecipientId
let senderDeviceId = messageContent.senderCertificate.senderDeviceId
guard senderDeviceId >= 0 && senderDeviceId <= INT32_MAX else {
throw SMKError.assertionError(description: "\(logTag) Invalid senderDeviceId.")
}
// switch (message.getType()) {
// case CiphertextMessage.WHISPER_TYPE: return new SessionCipher(signalProtocolStore, sender).decrypt(new
// SignalMessage(message.getContent())); case CiphertextMessage.PREKEY_TYPE: return new
// SessionCipher(signalProtocolStore, sender).decrypt(new PreKeySignalMessage(message.getContent())); default: throw
// new InvalidMessageException("Unknown type: " + message.getType());
// }
var cipherMessage: CipherMessage
switch (messageContent.messageType) {
case .whisper:
cipherMessage = WhisperMessage(data: messageContent.contentData)
case .prekey:
cipherMessage = PreKeyWhisperMessage(data: messageContent.contentData)
}
let cipher = SessionCipher(sessionStore: sessionStore,
preKeyStore: preKeyStore,
signedPreKeyStore: signedPreKeyStore,
identityKeyStore: identityStore,
recipientId: senderRecipientId,
deviceId: Int32(senderDeviceId))
let plaintextData = cipher.decrypt(cipherMessage, protocolContext: protocolContext)
return plaintextData
}
// private byte[] decrypt(SecretKeySpec cipherKey, SecretKeySpec macKey, byte[] ciphertext) throws InvalidMacException {
private func decrypt(cipherKey: SMKSecretKeySpec,
macKey: SMKSecretKeySpec,
cipherTextWithMac: Data) throws -> Data {
// if (ciphertext.count < 10) {
// throw new InvalidMacException("Ciphertext not long enough for MAC!");
// }
if (cipherTextWithMac.count < kSMKSecretSessionCipherMacLength) {
throw SMKError.assertionError(description: "\(logTag) Cipher text not long enough for MAC.")
}
// byte[][] ciphertextParts = ByteUtil.split(ciphertext, ciphertext.count - 10, 10);
let cipherTextWithMacParser = SSKDataParser(data: cipherTextWithMac)
let cipherTextLength = UInt(cipherTextWithMac.count) - kSMKSecretSessionCipherMacLength
let cipherText = try cipherTextWithMacParser.nextData(length: cipherTextLength, name: "cipher text")
let theirMac = try cipherTextWithMacParser.nextData(length: kSMKSecretSessionCipherMacLength, name: "their mac")
guard cipherTextWithMacParser.isEmpty else {
throw SMKError.assertionError(description: "\(logTag) Could not parse cipher text.")
}
// Mac mac = Mac.getInstance("HmacSHA256");
// mac.init(macKey);
//
// byte[] digest = mac.doFinal(ciphertextParts[0]);
guard let ourFullMac = Cryptography.computeSHA256HMAC(cipherText, withHMACKey: macKey.keyData) else {
throw SMKError.assertionError(description: "\(logTag) Could not compute HmacSHA256.")
}
// byte[] ourMac = ByteUtil.trim(digest, 10);
guard ourFullMac.count >= kSMKSecretSessionCipherMacLength else {
throw SMKError.assertionError(description: "\(logTag) HmacSHA256 has unexpected length.")
}
let ourMac = ourFullMac[0..<kSMKSecretSessionCipherMacLength]
// if (!MessageDigest.isEqual(ourMac, theirMac)) {
// throw new InvalidMacException("Bad mac!");
// }
//
// NOTE: Constant time comparison.
guard ourMac.ows_constantTimeIsEqual(to: theirMac) else {
throw SMKError.assertionError(description: "\(logTag) macs do not match.")
}
// Cipher cipher = Cipher.getInstance("AES/CTR/NoPadding");
// cipher.init(Cipher.DECRYPT_MODE, cipherKey, new IvParameterSpec(new byte[16]));
guard let aesKey = OWSAES256Key(data: cipherKey.keyData) else {
throw SMKError.assertionError(description: "\(logTag) could not parse AES256 key.")
}
// NOTE: The IV is all zeroes. This is fine since we're using a unique key.
let initializationVector = Data(count: Int(kAES256CTR_IVLength))
guard let plaintext = Cryptography.decryptAESCTR(cipherText: cipherText, initializationVector: initializationVector, key: aesKey) else {
throw SMKError.assertionError(description: "\(logTag) could not decrypt AESGCM.")
}
return plaintext
}
}

90
SignalMetadataKit/src/SMKSenderCertificate.swift Normal file
View File

@ -0,0 +1,90 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// See:
// https://github.com/signalapp/libsignal-metadata-java/blob/cac0dde9de416a192e64a8940503982820870090/java/src/main/java/org/signal/libsignal/metadata/certificate/SenderCertificate.java
@objc public class SMKSenderCertificate: NSObject {
@objc public let signer: SMKServerCertificate
@objc public let key: ECPublicKey
@objc public let senderDeviceId: UInt32
@objc public let senderRecipientId: String
@objc public let expirationTimestamp: UInt64
@objc public let signatureData: Data
@objc public init(signer: SMKServerCertificate,
key: ECPublicKey,
senderDeviceId: UInt32,
senderRecipientId: String,
expirationTimestamp: UInt64,
signatureData: Data) {
self.signer = signer
self.key = key
self.senderDeviceId = senderDeviceId
self.senderRecipientId = senderRecipientId
self.expirationTimestamp = expirationTimestamp
self.signatureData = signatureData
}
@objc public class func parse(data: Data) throws -> SMKSenderCertificate {
let proto = try SMKProtoSenderCertificate.parseData(data)
return try parse(proto: proto)
}
@objc public class func parse(proto: SMKProtoSenderCertificate) throws -> SMKSenderCertificate {
let certificateData = proto.certificate
let signatureData = proto.signature
let certificateProto = try SMKProtoSenderCertificateCertificate.parseData(certificateData)
let keyData = certificateProto.identityKey
let key = try ECPublicKey(serializedKeyData: keyData)
let senderDeviceId = certificateProto.senderDevice
let senderRecipientId = certificateProto.sender
let expirationTimestamp = certificateProto.expires
let signerProto = certificateProto.signer
let signer = try SMKServerCertificate.parse(proto: signerProto)
return SMKSenderCertificate(signer: signer, key: key, senderDeviceId: senderDeviceId, senderRecipientId: senderRecipientId, expirationTimestamp: expirationTimestamp, signatureData: signatureData)
}
@objc public func toProto() throws -> SMKProtoSenderCertificate {
let certificateBuilder = SMKProtoSenderCertificateCertificate.builder()
certificateBuilder.setSender(senderRecipientId)
certificateBuilder.setSenderDevice(senderDeviceId)
certificateBuilder.setExpires(expirationTimestamp)
certificateBuilder.setIdentityKey(key.serialized)
certificateBuilder.setSigner(try signer.toProto())
let builder =
SMKProtoSenderCertificate.builder()
builder.setCertificate(try certificateBuilder.buildSerializedData())
builder.setSignature(signatureData)
return try builder.build()
}
@objc public func serialized() throws -> Data {
return try toProto().serializedData()
}
open override func isEqual(_ other: Any?) -> Bool {
if let other = other as? SMKSenderCertificate {
return (signer.isEqual(other.signer) &&
key.isEqual(other.key) &&
senderDeviceId == other.senderDeviceId &&
senderRecipientId == other.senderRecipientId &&
expirationTimestamp == other.expirationTimestamp &&
signatureData == other.signatureData)
} else {
return false
}
}
public override var hash: Int {
return signer.hashValue ^ key.hashValue ^ senderDeviceId.hashValue ^ senderRecipientId.hashValue ^ expirationTimestamp.hashValue ^ signatureData.hashValue
}
}

67
SignalMetadataKit/src/SMKServerCertificate.swift Normal file
View File

@ -0,0 +1,67 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// See:
// https://github.com/signalapp/libsignal-metadata-java/blob/cac0dde9de416a192e64a8940503982820870090/java/src/main/java/org/signal/libsignal/metadata/certificate/ServerCertificate.java
@objc public class SMKServerCertificate: NSObject {
@objc public let keyId: UInt32
@objc public let key: ECPublicKey
@objc public let signatureData: Data
public init(keyId: UInt32,
key: ECPublicKey,
signatureData: Data) {
self.keyId = keyId
self.key = key
self.signatureData = signatureData
}
@objc public class func parse(data: Data) throws -> SMKServerCertificate {
let proto = try SMKProtoServerCertificate.parseData(data)
return try parse(proto: proto)
}
@objc public class func parse(proto: SMKProtoServerCertificate) throws -> SMKServerCertificate {
let signatureData = proto.signature
let certificateData = proto.certificate
let certificateProto = try SMKProtoServerCertificateCertificate.parseData(certificateData)
let keyId = certificateProto.id
let keyData = certificateProto.key
let key = try ECPublicKey(serializedKeyData: keyData)
return SMKServerCertificate(keyId: keyId, key: key, signatureData: signatureData)
}
@objc public func toProto() throws -> SMKProtoServerCertificate {
let certificateBuilder = SMKProtoServerCertificateCertificate.builder()
certificateBuilder.setId(keyId)
certificateBuilder.setKey(key.serialized)
let builder =
SMKProtoServerCertificate.builder()
builder.setCertificate(try certificateBuilder.buildSerializedData())
builder.setSignature(signatureData)
return try builder.build()
}
@objc public func serialized() throws -> Data {
return try toProto().serializedData()
}
open override func isEqual(_ other: Any?) -> Bool {
if let other = other as? SMKServerCertificate {
return (keyId == other.keyId &&
key.isEqual(other.key) &&
(signatureData == other.signatureData))
} else {
return false
}
}
public override var hash: Int {
return keyId.hashValue ^ key.hashValue ^ signatureData.hashValue
}
}

95
SignalMetadataKit/src/SMKUnidentifiedSenderMessage.swift Normal file
View File

@ -0,0 +1,95 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
// https://github.com/signalapp/libsignal-metadata-java/blob/master/java/src/main/java/org/signal/libsignal/metadata/protocol/UnidentifiedSenderMessage.java
@objc public class SMKUnidentifiedSenderMessage: NSObject {
@objc public static let kSMKMessageCipherTextVersion: UInt = 1
public let cipherTextVersion: UInt
public let ephemeralKey: ECPublicKey
public let encryptedStatic: Data
public let encryptedMessage: Data
public init(cipherTextVersion: UInt,
ephemeralKey: ECPublicKey,
encryptedStatic: Data,
encryptedMessage: Data) {
self.cipherTextVersion = cipherTextVersion
self.ephemeralKey = ephemeralKey
self.encryptedStatic = encryptedStatic
self.encryptedMessage = encryptedMessage
}
public init(ephemeralKey: ECPublicKey,
encryptedStatic: Data,
encryptedMessage: Data) {
self.cipherTextVersion = SMKUnidentifiedSenderMessage.kSMKMessageCipherTextVersion
self.ephemeralKey = ephemeralKey
self.encryptedStatic = encryptedStatic
self.encryptedMessage = encryptedMessage
}
@objc public class func parse(dataAndPrefix: Data) throws -> SMKUnidentifiedSenderMessage {
// public UnidentifiedSenderMessage(byte[] serialized)
// throws InvalidMetadataMessageException, InvalidMetadataVersionException
let parser = SSKDataParser(data: dataAndPrefix)
// this.version = ByteUtil.highBitsToInt(serialized[0]);
let versionByte = try parser.nextByte(name: "version byte")
let cipherTextVersion = UInt(SerializationUtilities.highBitsToInt(fromByte: versionByte))
// if (version > CIPHERTEXT_VERSION) {
// throw new InvalidMetadataVersionException("Unknown version: " + this.version);
// }
guard cipherTextVersion <= SMKUnidentifiedSenderMessage.kSMKMessageCipherTextVersion else {
throw SMKError.assertionError(description: "\(logTag) unknown cipher text version: \(cipherTextVersion)")
}
// SignalProtos.UnidentifiedSenderMessage unidentifiedSenderMessage =
// SignalProtos.UnidentifiedSenderMessage.parseFrom(ByteString.copyFrom(serialized, 1, serialized.length - 1));
let protoData = try parser.remainder(name: "proto data")
let proto = try SMKProtoUnidentifiedSenderMessage.parseData(protoData)
// if (!unidentifiedSenderMessage.hasEphemeralPublic() ||
// !unidentifiedSenderMessage.hasEncryptedStatic() ||
// !unidentifiedSenderMessage.hasEncryptedMessage())
// {
// throw new InvalidMetadataMessageException("Missing fields");
// }
// NOTE: These fields are required in the proto schema.
// this.ephemeral = Curve.decodePoint(unidentifiedSenderMessage.getEphemeralPublic().toByteArray(), 0);
let ephemeralKeyData = proto.ephemeralPublic
let ephemeralKey = try ECPublicKey(serializedKeyData: ephemeralKeyData)
// this.encryptedStatic = unidentifiedSenderMessage.getEncryptedStatic().toByteArray();
let encryptedStatic = proto.encryptedStatic
// this.encryptedMessage = unidentifiedSenderMessage.getEncryptedMessage().toByteArray();
let encryptedMessage = proto.encryptedMessage
return SMKUnidentifiedSenderMessage(cipherTextVersion: cipherTextVersion, ephemeralKey: ephemeralKey, encryptedStatic: encryptedStatic, encryptedMessage: encryptedMessage)
}
@objc public func toProto() throws -> SMKProtoUnidentifiedSenderMessage {
let builder = SMKProtoUnidentifiedSenderMessage.builder()
builder.setEphemeralPublic(ephemeralKey.serialized)
builder.setEncryptedStatic(encryptedStatic)
builder.setEncryptedMessage(encryptedMessage)
return try builder.build()
}
@objc public func serialized() throws -> Data {
let versionByte: UInt8 = UInt8((self.cipherTextVersion << 4 | self.cipherTextVersion) & 0xFF)
let versionBytes = [versionByte]
let versionData = Data(bytes: versionBytes)
let messageData = try toProto().serializedData()
return NSData.join([versionData, messageData])
}
}

64
SignalMetadataKit/src/SMKUnidentifiedSenderMessageContent.swift Normal file
View File

@ -0,0 +1,64 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import Foundation
@objc public enum SMKMessageType: Int {
case whisper
case prekey
}
// See:
// https://github.com/signalapp/libsignal-metadata-java/blob/0cbbbf23eaf9f46fdf2d9463f3dfab2fb3271292/java/src/main/java/org/signal/libsignal/metadata/protocol/UnidentifiedSenderMessageContent.java
@objc public class SMKUnidentifiedSenderMessageContent: NSObject {
@objc public let messageType: SMKMessageType
@objc public let senderCertificate: SMKSenderCertificate
@objc public let contentData: Data
@objc public init(messageType: SMKMessageType,
senderCertificate: SMKSenderCertificate,
contentData: Data) {
self.messageType = messageType
self.senderCertificate = senderCertificate
self.contentData = contentData
}
@objc public class func parse(data: Data) throws -> SMKUnidentifiedSenderMessageContent {
let proto = try SMKProtoUnidentifiedSenderMessageMessage.parseData(data)
// TODO: Should we have a default case in our switches? Probably.
var messageType: SMKMessageType
switch (proto.type) {
case .prekeyMessage:
messageType = .prekey
case .message:
messageType = .whisper
}
let contentData = proto.content
let senderCertificateProto = proto.senderCertificate
let senderCertificate = try SMKSenderCertificate.parse(proto: senderCertificateProto)
return SMKUnidentifiedSenderMessageContent(messageType: messageType, senderCertificate: senderCertificate, contentData: contentData)
}
@objc public func toProto() throws -> SMKProtoUnidentifiedSenderMessageMessage {
let builder = SMKProtoUnidentifiedSenderMessageMessage.builder()
switch messageType {
case .whisper:
builder.setType(SMKProtoUnidentifiedSenderMessageMessage.SMKProtoUnidentifiedSenderMessageMessageType.message)
case .prekey:
builder.setType(SMKProtoUnidentifiedSenderMessageMessage.SMKProtoUnidentifiedSenderMessageMessageType.prekeyMessage)
}
builder.setSenderCertificate(try senderCertificate.toProto())
builder.setContent(contentData)
return try builder.build()
}
@objc public func serialized() throws -> Data {
return try toProto().serializedData()
}
}

167
SignalMetadataKitTests/src/SMKMiscTest.swift Normal file
View File

@ -0,0 +1,167 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
class SMKTest: SignalBaseTest {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
func testECPrivateKey() {
let keyData = Randomness.generateRandomBytes(Int32(ECCKeyLength))!
let key = try! ECPrivateKey(keyData: keyData)
let key2 = try! ECPrivateKey(keyData: keyData)
XCTAssertEqual(key, key2)
}
func testECPublicKey() {
let keyData = Randomness.generateRandomBytes(Int32(ECCKeyLength))!
let key = try! ECPublicKey(keyData: keyData)
XCTAssertEqual(key.keyData, keyData)
let serializedData = key.serialized
let parsedKey = try! ECPublicKey(serializedKeyData: serializedData)
XCTAssertEqual(parsedKey.keyData, keyData)
XCTAssertEqual(key, parsedKey)
}
func testUDMessage() {
let keyData = Randomness.generateRandomBytes(Int32(ECCKeyLength))!
let ephemeralKey = try! ECPublicKey(keyData: keyData)
let encryptedStatic = Randomness.generateRandomBytes(100)!
let encryptedMessage = Randomness.generateRandomBytes(200)!
let message = SMKUnidentifiedSenderMessage(ephemeralKey: ephemeralKey,
encryptedStatic: encryptedStatic,
encryptedMessage: encryptedMessage)
let messageData = try! message.serialized()
let parsedMessage = try! SMKUnidentifiedSenderMessage.parse(dataAndPrefix: messageData)
XCTAssertEqual(message.cipherTextVersion, parsedMessage.cipherTextVersion)
XCTAssertEqual(message.ephemeralKey.keyData, parsedMessage.ephemeralKey.keyData)
XCTAssertEqual(message.encryptedStatic, parsedMessage.encryptedStatic)
XCTAssertEqual(message.encryptedMessage, parsedMessage.encryptedMessage)
}
func testUDServerCertificate() {
let keyId: UInt32 = 123
let key = try! ECPublicKey(keyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!)
let signatureData = Randomness.generateRandomBytes(100)!
let serverCertificate = SMKServerCertificate(keyId: keyId,
key: key,
signatureData: signatureData)
let serializedData = try! serverCertificate.serialized()
let parsed = try! SMKServerCertificate.parse(data: serializedData)
XCTAssertEqual(serverCertificate.keyId, parsed.keyId)
XCTAssertEqual(serverCertificate.key, parsed.key)
XCTAssertEqual(serverCertificate.signatureData, parsed.signatureData)
}
func testUDSenderCertificate() {
let serverCertificate = SMKServerCertificate(keyId: 123,
key: try! ECPublicKey(keyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
signatureData: Randomness.generateRandomBytes(100)!)
let key = try! ECPublicKey(keyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!)
let senderDeviceId: UInt32 = 456
let senderRecipientId = "+13213214321"
let expirationTimestamp: UInt64 = 789
let signatureData = Randomness.generateRandomBytes(100)!
let senderCertificate = SMKSenderCertificate(signer: serverCertificate,
key: key,
senderDeviceId: senderDeviceId,
senderRecipientId: senderRecipientId,
expirationTimestamp: expirationTimestamp,
signatureData: signatureData)
let serializedData = try! senderCertificate.serialized()
let parsed = try! SMKSenderCertificate.parse(data: serializedData)
XCTAssertEqual(senderCertificate.signer, parsed.signer)
XCTAssertEqual(senderCertificate.key, parsed.key)
XCTAssertEqual(senderCertificate.senderDeviceId, parsed.senderDeviceId)
XCTAssertEqual(senderCertificate.senderRecipientId, parsed.senderRecipientId)
XCTAssertEqual(senderCertificate.expirationTimestamp, parsed.expirationTimestamp)
XCTAssertEqual(senderCertificate.signatureData, parsed.signatureData)
}
func testUDMessageContent() {
let serverCertificate = SMKServerCertificate(keyId: 123,
key: try! ECPublicKey(keyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
signatureData: Randomness.generateRandomBytes(100)!)
let senderCertificate = SMKSenderCertificate(signer: serverCertificate,
key: try! ECPublicKey(keyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
senderDeviceId: 456,
senderRecipientId: "+13213214321",
expirationTimestamp: 789,
signatureData: Randomness.generateRandomBytes(100)!)
let contentData = Randomness.generateRandomBytes(200)!
let message = SMKUnidentifiedSenderMessageContent(messageType: .whisper,
senderCertificate: senderCertificate,
contentData: contentData)
let messageData = try! message.serialized()
let parsed = try! SMKUnidentifiedSenderMessageContent.parse(data: messageData)
XCTAssertEqual(message.messageType, parsed.messageType)
XCTAssertEqual(message.senderCertificate, parsed.senderCertificate)
XCTAssertEqual(message.contentData, parsed.contentData)
}
func testUDSessionCipher_encrypt() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+13213214321", deviceId: 456, registrationId: 123)
let bobMockClient = MockClient(recipientId: "+13213214322", deviceId: 321, registrationId: 512)
let certificateValidator = MockCertificateValidator()
let bobPrekey = bobMockClient.preKeyStore.createKey()
let bobSignedPrekey = bobMockClient.signedPreKeyStore.createKey()
let bobPreKeyBundle = PreKeyBundle(registrationId: bobMockClient.registrationId,
deviceId: bobMockClient.deviceId,
preKeyId: bobPrekey.id,
preKeyPublic: try! bobPrekey.keyPair.ecPublicKey().serialized,
signedPreKeyPublic: try! bobSignedPrekey.keyPair.ecPublicKey().serialized,
signedPreKeyId: bobSignedPrekey.id,
signedPreKeySignature: bobSignedPrekey.signature,
identityKey: try! bobMockClient.identityKeyPair.ecPublicKey().serialized)!
let aliceToBobSessionBuilder = aliceMockClient.createSessionBuilder(forRecipient: bobMockClient)
aliceToBobSessionBuilder.processPrekeyBundle(bobPreKeyBundle, protocolContext: nil)
let aliceToBobCipher = try! aliceMockClient.createSecretSessionCipher()
let plaintext = Randomness.generateRandomBytes(200)!
let paddedPlaintext = (plaintext as NSData).paddedMessageBody()!
let serverCertificate = SMKServerCertificate(keyId: 123,
key: try! ECPublicKey(keyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
signatureData: Randomness.generateRandomBytes(100)!)
let senderCertificate = SMKSenderCertificate(signer: serverCertificate,
key: try! aliceMockClient.identityKeyPair.ecPublicKey(),
senderDeviceId: UInt32(aliceMockClient.deviceId),
senderRecipientId: aliceMockClient.recipientId,
expirationTimestamp: 789,
signatureData: Randomness.generateRandomBytes(100)!)
let encryptedMessage = try! aliceToBobCipher.encryptMessage(recipientId: bobMockClient.recipientId,
deviceId: bobMockClient.deviceId,
paddedPlaintext: paddedPlaintext, senderCertificate: senderCertificate, protocolContext: nil)
let messageTimestamp = NSDate.ows_millisecondTimeStamp()
let bobToAliceCipher = try! bobMockClient.createSecretSessionCipher()
let decryptedMessage = try! bobToAliceCipher.decryptMessage(certificateValidator: certificateValidator, cipherTextData: encryptedMessage, timestamp: messageTimestamp, protocolContext: nil)
let payload = (decryptedMessage.paddedPayload as NSData).removePadding()
XCTAssertEqual(aliceMockClient.recipientId, decryptedMessage.senderRecipientId)
XCTAssertEqual(aliceMockClient.deviceId, Int32(decryptedMessage.senderDeviceId))
XCTAssertEqual(plaintext, payload)
}
}

346
SignalMetadataKitTests/src/SMKSecretSessionCipherTest.swift Normal file
View File

@ -0,0 +1,346 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
// https://github.com/signalapp/libsignal-metadata-java/blob/master/tests/src/test/java/org/signal/libsignal/metadata/SecretSessionCipherTest.java
// public class SecretSessionCipherTest extends TestCase {
class SMKSecretSessionCipherTest: SignalBaseTest {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
// public void testEncryptDecrypt() throws UntrustedIdentityException, InvalidKeyException, InvalidCertificateException, InvalidProtocolBufferException, InvalidMetadataMessageException, ProtocolDuplicateMessageException, ProtocolUntrustedIdentityException, ProtocolLegacyMessageException, ProtocolInvalidKeyException, InvalidMetadataVersionException, ProtocolInvalidVersionException, ProtocolInvalidMessageException, ProtocolInvalidKeyIdException, ProtocolNoSessionException {
func testEncryptDecrypt() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+14159999999", deviceId: 1, registrationId: 1234)
let bobMockClient = MockClient(recipientId: "+14158888888", deviceId: 1, registrationId: 1235)
// TestInMemorySignalProtocolStore aliceStore = new TestInMemorySignalProtocolStore();
// TestInMemorySignalProtocolStore bobStore = new TestInMemorySignalProtocolStore();
//
// initializeSessions(aliceStore, bobStore);
initializeSessions(aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
// ECKeyPair trustRoot = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
// SenderCertificate senderCertificate = createCertificateFor(trustRoot, "+14151111111", 1, aliceStore.getIdentityKeyPair().getPublicKey().getPublicKey(), 31337);
let senderCertificate = createCertificateFor(trustRoot: trustRoot,
senderRecipientId: aliceMockClient.recipientId,
senderDeviceId: UInt32(aliceMockClient.deviceId),
identityKey: try! aliceMockClient.identityKeyPair.ecPublicKey(),
expirationTimestamp: 31337)
// SecretSessionCipher aliceCipher = new SecretSessionCipher(aliceStore);
let aliceCipher: SMKSecretSessionCipher = try! aliceMockClient.createSecretSessionCipher()
// byte[] ciphertext = aliceCipher.encrypt(new SignalProtocolAddress("+14152222222", 1),
// senderCertificate, "smert za smert".getBytes());
// NOTE: The java tests don't bother padding the plaintext.
let alicePlaintext = "smert za smert".data(using: String.Encoding.utf8)!
let ciphertext = try! aliceCipher.encryptMessage(recipientId: bobMockClient.recipientId,
deviceId: bobMockClient.deviceId,
paddedPlaintext: alicePlaintext,
senderCertificate: senderCertificate,
protocolContext: nil)
// SecretSessionCipher bobCipher = new SecretSessionCipher(bobStore);
let bobCipher: SMKSecretSessionCipher = try! bobMockClient.createSecretSessionCipher()
// Pair<SignalProtocolAddress, byte[]> plaintext = bobCipher.decrypt(new CertificateValidator(trustRoot.getPublicKey()), ciphertext, 31335);
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
let bobPlaintext = try! bobCipher.decryptMessage(certificateValidator: certificateValidator,
cipherTextData: ciphertext,
timestamp: 31335,
protocolContext: nil)
// assertEquals(new String(plaintext.second()), "smert za smert");
XCTAssertEqual(bobPlaintext.paddedPayload, alicePlaintext)
// assertEquals(plaintext.first().getName(), "+14151111111");
XCTAssertEqual(bobPlaintext.senderRecipientId, aliceMockClient.recipientId)
// assertEquals(plaintext.first().getDeviceId(), 1);
XCTAssertEqual(bobPlaintext.senderDeviceId, Int(aliceMockClient.deviceId))
}
// public void testEncryptDecryptUntrusted() throws Exception {
func testEncryptDecryptUntrusted() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+14159999999", deviceId: 1, registrationId: 1234)
let bobMockClient = MockClient(recipientId: "+14158888888", deviceId: 1, registrationId: 1235)
// TestInMemorySignalProtocolStore aliceStore = new TestInMemorySignalProtocolStore();
// TestInMemorySignalProtocolStore bobStore = new TestInMemorySignalProtocolStore();
//
// initializeSessions(aliceStore, bobStore);
initializeSessions(aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
// ECKeyPair trustRoot = Curve.generateKeyPair();
// ECKeyPair falseTrustRoot = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
let falseTrustRoot = Curve25519.generateKeyPair()
// SenderCertificate senderCertificate = createCertificateFor(falseTrustRoot, "+14151111111", 1, aliceStore.getIdentityKeyPair().getPublicKey().getPublicKey(), 31337);
let senderCertificate = createCertificateFor(trustRoot: falseTrustRoot,
senderRecipientId: aliceMockClient.recipientId,
senderDeviceId: UInt32(aliceMockClient.deviceId),
identityKey: try! aliceMockClient.identityKeyPair.ecPublicKey(),
expirationTimestamp: 31337)
// SecretSessionCipher aliceCipher = new SecretSessionCipher(aliceStore);
let aliceCipher: SMKSecretSessionCipher = try! aliceMockClient.createSecretSessionCipher()
// byte[] ciphertext = aliceCipher.encrypt(new SignalProtocolAddress("+14152222222", 1),
// senderCertificate, "и вот я".getBytes());
// NOTE: The java tests don't bother padding the plaintext.
let alicePlaintext = "и вот я".data(using: String.Encoding.utf8)!
let ciphertext = try! aliceCipher.encryptMessage(recipientId: bobMockClient.recipientId,
deviceId: bobMockClient.deviceId,
paddedPlaintext: alicePlaintext,
senderCertificate: senderCertificate,
protocolContext: nil)
// SecretSessionCipher bobCipher = new SecretSessionCipher(bobStore);
let bobCipher: SMKSecretSessionCipher = try! bobMockClient.createSecretSessionCipher()
// try {
// bobCipher.decrypt(new CertificateValidator(trustRoot.getPublicKey()), ciphertext, 31335);
// throw new AssertionError();
// } catch (InvalidMetadataMessageException e) {
// // good
// }
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
do {
try bobCipher.decryptMessage(certificateValidator: certificateValidator,
cipherTextData: ciphertext,
timestamp: 31335,
protocolContext: nil)
XCTFail("Decryption should have failed.")
} catch {
// Decryption is expected to fail.
XCTAssertTrue(error is SMKError)
}
}
// public void testEncryptDecryptExpired() throws Exception {
func testEncryptDecryptExpired() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+14159999999", deviceId: 1, registrationId: 1234)
let bobMockClient = MockClient(recipientId: "+14158888888", deviceId: 1, registrationId: 1235)
// TestInMemorySignalProtocolStore aliceStore = new TestInMemorySignalProtocolStore();
// TestInMemorySignalProtocolStore bobStore = new TestInMemorySignalProtocolStore();
//
// initializeSessions(aliceStore, bobStore);
initializeSessions(aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
// ECKeyPair trustRoot = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
// SenderCertificate senderCertificate = createCertificateFor(trustRoot, "+14151111111", 1, aliceStore.getIdentityKeyPair().getPublicKey().getPublicKey(), 31337);
let senderCertificate = createCertificateFor(trustRoot: trustRoot,
senderRecipientId: aliceMockClient.recipientId,
senderDeviceId: UInt32(aliceMockClient.deviceId),
identityKey: try! aliceMockClient.identityKeyPair.ecPublicKey(),
expirationTimestamp: 31337)
// SecretSessionCipher aliceCipher = new SecretSessionCipher(aliceStore);
let aliceCipher: SMKSecretSessionCipher = try! aliceMockClient.createSecretSessionCipher()
// byte[] ciphertext = aliceCipher.encrypt(new SignalProtocolAddress("+14152222222", 1),
// senderCertificate, "и вот я".getBytes());
// NOTE: The java tests don't bother padding the plaintext.
let alicePlaintext = "и вот я".data(using: String.Encoding.utf8)!
let ciphertext = try! aliceCipher.encryptMessage(recipientId: bobMockClient.recipientId,
deviceId: bobMockClient.deviceId,
paddedPlaintext: alicePlaintext,
senderCertificate: senderCertificate,
protocolContext: nil)
// SecretSessionCipher bobCipher = new SecretSessionCipher(bobStore);
let bobCipher: SMKSecretSessionCipher = try! bobMockClient.createSecretSessionCipher()
// try {
// bobCipher.decrypt(new CertificateValidator(trustRoot.getPublicKey()), ciphertext, 31338);
// throw new AssertionError();
// } catch (InvalidMetadataMessageException e) {
// // good
// }
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
do {
try bobCipher.decryptMessage(certificateValidator: certificateValidator,
cipherTextData: ciphertext,
timestamp: 31338,
protocolContext: nil)
XCTFail("Decryption should have failed.")
} catch {
// Decryption is expected to fail.
XCTAssertTrue(error is SMKError)
}
}
// public void testEncryptFromWrongIdentity() throws Exception {
func testEncryptFromWrongIdentity() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+14159999999", deviceId: 1, registrationId: 1234)
let bobMockClient = MockClient(recipientId: "+14158888888", deviceId: 1, registrationId: 1235)
// TestInMemorySignalProtocolStore aliceStore = new TestInMemorySignalProtocolStore();
// TestInMemorySignalProtocolStore bobStore = new TestInMemorySignalProtocolStore();
//
// initializeSessions(aliceStore, bobStore);
initializeSessions(aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
// ECKeyPair trustRoot = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
// ECKeyPair randomKeyPair = Curve.generateKeyPair();
let randomKeyPair = Curve25519.generateKeyPair()
// SenderCertificate senderCertificate = createCertificateFor(trustRoot, "+14151111111", 1, randomKeyPair.getPublicKey(), 31337);
let senderCertificate = createCertificateFor(trustRoot: trustRoot,
senderRecipientId: aliceMockClient.recipientId,
senderDeviceId: UInt32(aliceMockClient.deviceId),
identityKey: try! randomKeyPair.ecPublicKey(),
expirationTimestamp: 31337)
// SecretSessionCipher aliceCipher = new SecretSessionCipher(aliceStore);
let aliceCipher: SMKSecretSessionCipher = try! aliceMockClient.createSecretSessionCipher()
// byte[] ciphertext = aliceCipher.encrypt(new SignalProtocolAddress("+14152222222", 1),
// senderCertificate, "smert za smert".getBytes());
// NOTE: The java tests don't bother padding the plaintext.
let alicePlaintext = "smert za smert".data(using: String.Encoding.utf8)!
let ciphertext = try! aliceCipher.encryptMessage(recipientId: bobMockClient.recipientId,
deviceId: bobMockClient.deviceId,
paddedPlaintext: alicePlaintext,
senderCertificate: senderCertificate,
protocolContext: nil)
// SecretSessionCipher bobCipher = new SecretSessionCipher(bobStore);
let bobCipher: SMKSecretSessionCipher = try! bobMockClient.createSecretSessionCipher()
// try {
// bobCipher.decrypt(new CertificateValidator(trustRoot.getPublicKey()), ciphertext, 31335);
// } catch (InvalidMetadataMessageException e) {
// // good
// }
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
do {
try bobCipher.decryptMessage(certificateValidator: certificateValidator,
cipherTextData: ciphertext,
timestamp: 31335,
protocolContext: nil)
XCTFail("Decryption should have failed.")
} catch {
// Decryption is expected to fail.
XCTAssertTrue(error is SMKError)
}
}
// MARK: - Utils
// private SenderCertificate createCertificateFor(ECKeyPair trustRoot, String sender, int deviceId, ECPublicKey identityKey, long expires)
// throws InvalidKeyException, InvalidCertificateException, InvalidProtocolBufferException {
private func createCertificateFor(trustRoot: ECKeyPair,
senderRecipientId: String,
senderDeviceId: UInt32,
identityKey: ECPublicKey,
expirationTimestamp: UInt64) -> SMKSenderCertificate {
// ECKeyPair serverKey = Curve.generateKeyPair();
let serverKey = Curve25519.generateKeyPair()
// byte[] serverCertificateBytes = SignalProtos.ServerCertificate.Certificate.newBuilder()
// .setId(1)
// .setKey(ByteString.copyFrom(serverKey.getPublicKey().serialize()))
// .build()
// .toByteArray();
let keyId: UInt32 = 1
let unsignedServerCertificateBuilder = SMKProtoServerCertificateCertificate.builder()
unsignedServerCertificateBuilder.setId(keyId)
unsignedServerCertificateBuilder.setKey(try! serverKey.ecPublicKey().serialized)
let unsignedServerCertificateData = try! unsignedServerCertificateBuilder.build().serializedData()
// byte[] serverCertificateSignature = Curve.calculateSignature(trustRoot.getPrivateKey(), serverCertificateBytes);
let serverCertificateSignature = Ed25519.sign(unsignedServerCertificateData, with: trustRoot)!
// ServerCertificate serverCertificate = new ServerCertificate(SignalProtos.ServerCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(serverCertificateBytes))
// .setSignature(ByteString.copyFrom(serverCertificateSignature))
// .build()
// .toByteArray());
let signedServerCertificate = SMKServerCertificate(keyId: keyId,
key: try! serverKey.ecPublicKey(),
signatureData: serverCertificateSignature)
XCTAssertEqual(try! signedServerCertificate.toProto().certificate, unsignedServerCertificateData)
let signedServerCertificateData = try! signedServerCertificate.serialized()
// byte[] senderCertificateBytes = SignalProtos.SenderCertificate.Certificate.newBuilder()
// .setSender(sender)
// .setSenderDevice(deviceId)
// .setIdentityKey(ByteString.copyFrom(identityKey.serialize()))
// .setExpires(expires)
// .setSigner(SignalProtos.ServerCertificate.parseFrom(serverCertificate.getSerialized()))
// .build()
// .toByteArray();
let unsignedSenderCertificateBuilder = SMKProtoSenderCertificateCertificate.builder()
unsignedSenderCertificateBuilder.setSender(senderRecipientId)
unsignedSenderCertificateBuilder.setSenderDevice(senderDeviceId)
unsignedSenderCertificateBuilder.setExpires(expirationTimestamp)
unsignedSenderCertificateBuilder.setIdentityKey(identityKey.serialized)
unsignedSenderCertificateBuilder.setSigner(try! signedServerCertificate.toProto())
let unsignedSenderCertificateData = try! unsignedSenderCertificateBuilder.build().serializedData()
// byte[] senderCertificateSignature = Curve.calculateSignature(serverKey.getPrivateKey(), senderCertificateBytes);
let senderCertificateSignature = Ed25519.sign(unsignedSenderCertificateData, with: serverKey)!
// return new SenderCertificate(SignalProtos.SenderCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(senderCertificateBytes))
// .setSignature(ByteString.copyFrom(senderCertificateSignature))
// .build()
// .toByteArray());
let signedSenderCertificate = SMKSenderCertificate(signer: signedServerCertificate,
key: identityKey,
senderDeviceId: senderDeviceId,
senderRecipientId: senderRecipientId,
expirationTimestamp: expirationTimestamp,
signatureData: senderCertificateSignature)
XCTAssertEqual(try! signedSenderCertificate.signer.toProto().certificate, unsignedServerCertificateData)
return signedSenderCertificate
}
// private void initializeSessions(TestInMemorySignalProtocolStore aliceStore, TestInMemorySignalProtocolStore bobStore)
// throws InvalidKeyException, UntrustedIdentityException
// {
private func initializeSessions(aliceMockClient: MockClient,
bobMockClient: MockClient) {
// ECKeyPair bobPreKey = Curve.generateKeyPair();
let bobPreKey = bobMockClient.preKeyStore.createKey()
// IdentityKeyPair bobIdentityKey = bobStore.getIdentityKeyPair();
let bobIdentityKey = bobMockClient.identityKeyPair
// SignedPreKeyRecord bobSignedPreKey = KeyHelper.generateSignedPreKey(bobIdentityKey, 2);
let bobSignedPreKey = bobMockClient.signedPreKeyStore.createKey()
//
// PreKeyBundle bobBundle = new PreKeyBundle(1, 1, 1, bobPreKey.getPublicKey(), 2, bobSignedPreKey.getKeyPair().getPublicKey(), bobSignedPreKey.getSignature(), bobIdentityKey.getPublicKey());
let bobBundle = PreKeyBundle(registrationId: bobMockClient.registrationId,
deviceId: bobMockClient.deviceId,
preKeyId: bobPreKey.id,
preKeyPublic: try! bobPreKey.keyPair.ecPublicKey().serialized,
signedPreKeyPublic: try! bobSignedPreKey.keyPair.ecPublicKey().serialized,
signedPreKeyId: bobSignedPreKey.id,
signedPreKeySignature: bobSignedPreKey.signature,
identityKey: try! bobIdentityKey.ecPublicKey().serialized)!
// SessionBuilder aliceSessionBuilder = new SessionBuilder(aliceStore, new SignalProtocolAddress("+14152222222", 1));
let aliceSessionBuilder = aliceMockClient.createSessionBuilder(forRecipient: bobMockClient)
// aliceSessionBuilder.process(bobBundle);
aliceSessionBuilder.processPrekeyBundle(bobBundle, protocolContext: nil)
// bobStore.storeSignedPreKey(2, bobSignedPreKey);
// bobStore.storePreKey(1, new PreKeyRecord(1, bobPreKey));
// NOTE: These stores are taken care of in the mocks' createKey() methods above.
}
}

220
SignalMetadataKitTests/src/SMKSenderCertificateTest.swift Normal file
View File

@ -0,0 +1,220 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
// See: https://github.com/signalapp/libsignal-metadata-java/blob/master/tests/src/test/java/org/signal/libsignal/metadata/certificate/SenderCertificateTest.java
//
//public class SenderCertificateTest extends TestCase {
class SMKSenderCertificateTest: SignalBaseTest {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
// private final ECKeyPair trustRoot = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
// public void testSignature() throws InvalidCertificateException, InvalidKeyException {
func testSignature() {
// ECKeyPair serverKey = Curve.generateKeyPair();
// ECKeyPair key = Curve.generateKeyPair();
let serverKey = Curve25519.generateKeyPair()
let key = Curve25519.generateKeyPair()
// byte[] certificateBytes = SignalProtos.SenderCertificate.Certificate.newBuilder()
// .setSender("+14152222222")
// .setSenderDevice(1)
// .setExpires(31337)
// .setIdentityKey(ByteString.copyFrom(key.getPublicKey().serialize()))
// .setSigner(getServerCertificate(serverKey))
// .build()
// .toByteArray();
let senderRecipientId = "+14152222222"
let senderDeviceId: UInt32 = 1
let expirationTimestamp: UInt64 = 31337
let serverCertificate = getServerCertificate(serverKey: serverKey, trustRoot: trustRoot)
let unsignedCertificateBuilder = SMKProtoSenderCertificateCertificate.builder()
unsignedCertificateBuilder.setSender(senderRecipientId)
unsignedCertificateBuilder.setSenderDevice(senderDeviceId)
unsignedCertificateBuilder.setExpires(expirationTimestamp)
unsignedCertificateBuilder.setIdentityKey(try! key.ecPublicKey().serialized)
unsignedCertificateBuilder.setSigner(try! serverCertificate.toProto())
let unsignedSenderCertificateData = try! unsignedCertificateBuilder.build().serializedData()
// byte[] certificateSignature = Curve.calculateSignature(serverKey.getPrivateKey(), certificateBytes);
let senderCertificateSignature = Ed25519.sign(unsignedSenderCertificateData, with: serverKey)!
// SenderCertificate senderCertificate = new SenderCertificate(SignalProtos.SenderCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(certificateBytes))
// .setSignature(ByteString.copyFrom(certificateSignature))
// .build()
// .toByteArray());
let signedSenderCertificate = SMKSenderCertificate(signer: serverCertificate,
key: try! key.ecPublicKey(),
senderDeviceId: senderDeviceId,
senderRecipientId: senderRecipientId,
expirationTimestamp: expirationTimestamp,
signatureData: senderCertificateSignature)
// new CertificateValidator(trustRoot.getPublicKey()).validate(senderCertificate, 31336);
let certificateValidator = try! SMKCertificateDefaultValidator(trustRoot: trustRoot.ecPublicKey())
try! certificateValidator.validate(senderCertificate: signedSenderCertificate, validationTime: 31336)
}
// public void testExpiredSignature() throws InvalidCertificateException, InvalidKeyException {
func testExpiredSignature() {
// ECKeyPair serverKey = Curve.generateKeyPair();
// ECKeyPair key = Curve.generateKeyPair();
let serverKey = Curve25519.generateKeyPair()
let key = Curve25519.generateKeyPair()
// byte[] certificateBytes = SignalProtos.SenderCertificate.Certificate.newBuilder()
// .setSender("+14152222222")
// .setSenderDevice(1)
// .setExpires(31337)
// .setIdentityKey(ByteString.copyFrom(key.getPublicKey().serialize()))
// .setSigner(getServerCertificate(serverKey))
// .build()
// .toByteArray();
let senderRecipientId = "+14152222222"
let senderDeviceId: UInt32 = 1
let expirationTimestamp: UInt64 = 31337
let serverCertificate = getServerCertificate(serverKey: serverKey, trustRoot: trustRoot)
let unsignedCertificateBuilder = SMKProtoSenderCertificateCertificate.builder()
unsignedCertificateBuilder.setSender(senderRecipientId)
unsignedCertificateBuilder.setSenderDevice(senderDeviceId)
unsignedCertificateBuilder.setExpires(expirationTimestamp)
unsignedCertificateBuilder.setIdentityKey(try! key.ecPublicKey().serialized)
unsignedCertificateBuilder.setSigner(try! serverCertificate.toProto())
let unsignedSenderCertificateData = try! unsignedCertificateBuilder.build().serializedData()
// byte[] certificateSignature = Curve.calculateSignature(serverKey.getPrivateKey(), certificateBytes);
let senderCertificateSignature = Ed25519.sign(unsignedSenderCertificateData, with: serverKey)!
// SenderCertificate senderCertificate = new SenderCertificate(SignalProtos.SenderCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(certificateBytes))
// .setSignature(ByteString.copyFrom(certificateSignature))
// .build()
// .toByteArray());
let signedSenderCertificate = SMKSenderCertificate(signer: serverCertificate,
key: try! key.ecPublicKey(),
senderDeviceId: senderDeviceId,
senderRecipientId: senderRecipientId,
expirationTimestamp: expirationTimestamp,
signatureData: senderCertificateSignature)
// try {
// new CertificateValidator(trustRoot.getPublicKey()).validate(senderCertificate, 31338);
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
let certificateValidator = try! SMKCertificateDefaultValidator(trustRoot: trustRoot.ecPublicKey())
XCTAssertThrowsError(try certificateValidator.validate(senderCertificate: signedSenderCertificate, validationTime: 31338))
}
// public void testBadSignature() throws InvalidCertificateException, InvalidKeyException {
func testBadSignature() {
// ECKeyPair serverKey = Curve.generateKeyPair();
// ECKeyPair key = Curve.generateKeyPair();
let serverKey = Curve25519.generateKeyPair()
let key = Curve25519.generateKeyPair()
// byte[] certificateBytes = SignalProtos.SenderCertificate.Certificate.newBuilder()
// .setSender("+14152222222")
// .setSenderDevice(1)
// .setExpires(31337)
// .setIdentityKey(ByteString.copyFrom(key.getPublicKey().serialize()))
// .setSigner(getServerCertificate(serverKey))
// .build()
// .toByteArray();
let senderRecipientId = "+14152222222"
let senderDeviceId: UInt32 = 1
let expirationTimestamp: UInt64 = 31337
let serverCertificate = getServerCertificate(serverKey: serverKey, trustRoot: trustRoot)
let unsignedCertificateBuilder = SMKProtoSenderCertificateCertificate.builder()
unsignedCertificateBuilder.setSender(senderRecipientId)
unsignedCertificateBuilder.setSenderDevice(senderDeviceId)
unsignedCertificateBuilder.setExpires(expirationTimestamp)
unsignedCertificateBuilder.setIdentityKey(try! key.ecPublicKey().serialized)
unsignedCertificateBuilder.setSigner(try! serverCertificate.toProto())
let unsignedSenderCertificateData = try! unsignedCertificateBuilder.build().serializedData()
// byte[] certificateSignature = Curve.calculateSignature(serverKey.getPrivateKey(), certificateBytes);
let senderCertificateSignature = Ed25519.sign(unsignedSenderCertificateData, with: serverKey)!
// for (int i=0;i<certificateSignature.length;i++) {
for i in 0..<senderCertificateSignature.count {
// for (int b=0;b<8;b++) {
for b in 0..<8 {
// byte[] badSignature = new byte[certificateSignature.length];
// System.arraycopy(certificateSignature, 0, badSignature, 0, certificateSignature.length);
var badSignature = senderCertificateSignature
// badSignature[i] = (byte)(badSignature[i] ^ 1 << b);
badSignature.withUnsafeMutableBytes { (bytes: UnsafeMutablePointer<UInt8>) in
bytes[i] = (UInt8)(bytes[i] ^ 1 << b)
}
// SenderCertificate senderCertificate = new SenderCertificate(SignalProtos.SenderCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(certificateBytes))
// .setSignature(ByteString.copyFrom(badSignature))
// .build()
// .toByteArray());
let signedSenderCertificate = SMKSenderCertificate(signer: serverCertificate,
key: try! key.ecPublicKey(),
senderDeviceId: senderDeviceId,
senderRecipientId: senderRecipientId,
expirationTimestamp: expirationTimestamp,
signatureData: badSignature)
// try {
// new CertificateValidator(trustRoot.getPublicKey()).validate(senderCertificate, 31336);
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
let certificateValidator = try! SMKCertificateDefaultValidator(trustRoot: trustRoot.ecPublicKey())
XCTAssertThrowsError(try certificateValidator.validate(senderCertificate: signedSenderCertificate, validationTime: 31336))
}
}
}
// MARK: - Utils
// private SignalProtos.ServerCertificate getServerCertificate(ECKeyPair serverKey) throws InvalidKeyException, InvalidCertificateException {
private func getServerCertificate(serverKey: ECKeyPair, trustRoot: ECKeyPair) -> SMKServerCertificate {
// byte[] certificateBytes = SignalProtos.ServerCertificate.Certificate.newBuilder()
// .setId(1)
// .setKey(ByteString.copyFrom(serverKey.getPublicKey().serialize()))
// .build()
// .toByteArray();
let keyId: UInt32 = 1
let unsignedServerCertificateBuilder = SMKProtoServerCertificateCertificate.builder()
unsignedServerCertificateBuilder.setId(keyId)
unsignedServerCertificateBuilder.setKey(try! serverKey.ecPublicKey().serialized)
let unsignedServerCertificateData = try! unsignedServerCertificateBuilder.build().serializedData()
// byte[] certificateSignature = Curve.calculateSignature(trustRoot.getPrivateKey(), certificateBytes);
let serverCertificateSignature = Ed25519.sign(unsignedServerCertificateData, with: trustRoot)!
// return SignalProtos.ServerCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(certificateBytes))
// .setSignature(ByteString.copyFrom(certificateSignature))
// .build();
let signedServerCertificate = SMKServerCertificate(keyId: keyId,
key: try! serverKey.ecPublicKey(),
signatureData: serverCertificateSignature)
return signedServerCertificate
}
}

201
SignalMetadataKitTests/src/SMKServerCertificateTest.swift Normal file
View File

@ -0,0 +1,201 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
import SwiftProtobuf
// See: https://github.com/signalapp/libsignal-metadata-java/blob/master/tests/src/test/java/org/signal/libsignal/metadata/certificate/ServerCertificateTest.java
//
// public class ServerCertificateTest extends TestCase {
class SMKServerCertificateTest: SignalBaseTest {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
// public void testBadFields() {
func testBadFields() {
// NOTE: We don't want to (and can't) test this.
// Our Swift proto wrappers ensure that we never have missing fields.
// SignalProtos.ServerCertificate.Certificate.Builder certificate = SignalProtos.ServerCertificate.Certificate.newBuilder();
//
// try {
// new ServerCertificate(SignalProtos.ServerCertificate.newBuilder().setSignature(ByteString.copyFrom(new byte[64])).build().toByteArray());
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
//
// try {
// new ServerCertificate(SignalProtos.ServerCertificate.newBuilder().setCertificate(certificate.build().toByteString())
// .setSignature(ByteString.copyFrom(new byte[64])).build().toByteArray());
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
//
// try {
// new ServerCertificate(SignalProtos.ServerCertificate.newBuilder().setCertificate(certificate.setId(1).build().toByteString())
// .setSignature(ByteString.copyFrom(new byte[64])).build().toByteArray());
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
}
// public void testSignature() throws InvalidKeyException, InvalidCertificateException {
func testSignature() {
// ECKeyPair trustRoot = Curve.generateKeyPair();
// ECKeyPair keyPair = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
let keyPair = Curve25519.generateKeyPair()
// SignalProtos.ServerCertificate.Certificate certificate = SignalProtos.ServerCertificate.Certificate.newBuilder()
// .setId(1)
// .setKey(ByteString.copyFrom(keyPair.getPublicKey().serialize()))
// .build();
let keyId: UInt32 = 1
let unsignedServerCertificateBuilder = SMKProtoServerCertificateCertificate.builder()
unsignedServerCertificateBuilder.setId(keyId)
unsignedServerCertificateBuilder.setKey(try! keyPair.ecPublicKey().serialized)
// byte[] certificateBytes = certificate.toByteArray();
let unsignedServerCertificateData = try! unsignedServerCertificateBuilder.build().serializedData()
// byte[] certificateSignature = Curve.calculateSignature(trustRoot.getPrivateKey(), certificateBytes);
let serverCertificateSignature = Ed25519.sign(unsignedServerCertificateData, with: trustRoot)!
// byte[] serialized = SignalProtos.ServerCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(certificateBytes))
// .setSignature(ByteString.copyFrom(certificateSignature))
// .build().toByteArray();
let signedServerCertificate = SMKServerCertificate(keyId: keyId,
key: try! keyPair.ecPublicKey(),
signatureData: serverCertificateSignature)
let serializedData = try! signedServerCertificate.serialized()
let parsed = try! SMKServerCertificate.parse(data: serializedData)
// new CertificateValidator(trustRoot.getPublicKey()).validate(new ServerCertificate(serialized));
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
try! certificateValidator.validate(serverCertificate: parsed)
}
// public void testBadSignature() throws Exception {
func testBadSignature() {
// ECKeyPair trustRoot = Curve.generateKeyPair();
// ECKeyPair keyPair = Curve.generateKeyPair();
let trustRoot = Curve25519.generateKeyPair()
let keyPair = Curve25519.generateKeyPair()
// SignalProtos.ServerCertificate.Certificate certificate = SignalProtos.ServerCertificate.Certificate.newBuilder()
// .setId(1)
// .setKey(ByteString.copyFrom(keyPair.getPublicKey().serialize()))
// .build();
let keyId: UInt32 = 1
let unsignedServerCertificateBuilder = SMKProtoServerCertificateCertificate.builder()
unsignedServerCertificateBuilder.setId(keyId)
unsignedServerCertificateBuilder.setKey(try! keyPair.ecPublicKey().serialized)
// byte[] certificateBytes = certificate.toByteArray();
let unsignedServerCertificateData = try! unsignedServerCertificateBuilder.build().serializedData()
// byte[] certificateSignature = Curve.calculateSignature(trustRoot.getPrivateKey(), certificateBytes);
let serverCertificateSignature = Ed25519.sign(unsignedServerCertificateData, with: trustRoot)!
// for (int i=0;i<certificateSignature.length;i++) {
for i in 0..<serverCertificateSignature.count {
// for (int b=0;b<8;b++) {
for b in 0..<8 {
// byte[] badSignature = new byte[certificateSignature.length];
// System.arraycopy(certificateSignature, 0, badSignature, 0, badSignature.length);
var badSignature = serverCertificateSignature
// badSignature[i] = (byte) (badSignature[i] ^ (1 << b));
badSignature.withUnsafeMutableBytes { (bytes: UnsafeMutablePointer<UInt8>) in
bytes[i] = (UInt8)(bytes[i] ^ 1 << b)
}
// byte[] serialized = SignalProtos.ServerCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(certificateBytes))
// .setSignature(ByteString.copyFrom(badSignature))
// .build().toByteArray();
let signedServerCertificate = SMKServerCertificate(keyId: keyId,
key: try! keyPair.ecPublicKey(),
signatureData: badSignature)
let serializedData = try! signedServerCertificate.serialized()
let parsed = try! SMKServerCertificate.parse(data: serializedData)
// try {
// new CertificateValidator(trustRoot.getPublicKey()).validate(new ServerCertificate(serialized));
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
XCTAssertThrowsError(try certificateValidator.validate(serverCertificate: parsed))
}
}
// for (int i=0;i<certificateBytes.length;i++) {
for i in 0..<unsignedServerCertificateData.count {
// for (int b=0;b<8;b++) {
for b in 0..<8 {
// byte[] badCertificate = new byte[certificateBytes.length];
// System.arraycopy(certificateBytes, 0, badCertificate, 0, badCertificate.length);
var badCertificate = unsignedServerCertificateData
// badCertificate[i] = (byte) (badCertificate[i] ^ (1 << b));
badCertificate.withUnsafeMutableBytes { (bytes: UnsafeMutablePointer<UInt8>) in
bytes[i] = (UInt8)(bytes[i] ^ 1 << b)
}
// byte[] serialized = SignalProtos.ServerCertificate.newBuilder()
// .setCertificate(ByteString.copyFrom(badCertificate))
// .setSignature(ByteString.copyFrom(certificateSignature))
// .build().toByteArray();
let builder =
SMKProtoServerCertificate.builder()
builder.setCertificate(badCertificate)
builder.setSignature(serverCertificateSignature)
let serializedData = try! builder.buildSerializedData()
let parsed: SMKServerCertificate
do {
parsed = try SMKServerCertificate.parse(data: serializedData)
} catch BinaryDecodingError.malformedProtobuf {
// Some bad certificates will fail to parse.
continue
} catch BinaryDecodingError.truncated {
// Some bad certificates will fail to parse.
continue
} catch SMKProtoError.invalidProtobuf {
// Some bad certificates will fail to parse.
continue
} catch SMKError.assertionError {
// Some bad certificates will fail to parse.
continue
} catch {
XCTFail("Unexpected parsing error: \(error)")
continue
}
//
// try {
// new CertificateValidator(trustRoot.getPublicKey()).validate(new ServerCertificate(serialized));
// throw new AssertionError();
// } catch (InvalidCertificateException e) {
// // good
// }
// }
let certificateValidator = SMKCertificateDefaultValidator(trustRoot: try! trustRoot.ecPublicKey())
XCTAssertThrowsError(try certificateValidator.validate(serverCertificate: parsed))
}
}
}
}

330
SignalMetadataKitTests/src/SMKSessionCipherTest.swift Normal file
View File

@ -0,0 +1,330 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
extension MutableCollection {
/// Shuffles the contents of this collection.
mutating func ows_shuffle() {
let c = count
guard c > 1 else { return }
for (firstUnshuffled, unshuffledCount) in zip(indices, stride(from: c, to: 1, by: -1)) {
// Change `Int` in the next line to `IndexDistance` in < Swift 4.1
let d: Int = numericCast(arc4random_uniform(numericCast(unshuffledCount)))
let i = index(firstUnshuffled, offsetBy: d)
swapAt(firstUnshuffled, i)
}
}
}
extension Sequence {
/// Returns an array with the contents of this sequence, shuffled.
func shuffled() -> [Element] {
var result = Array(self)
result.ows_shuffle()
return result
}
}
// See: https://github.com/signalapp/libsignal-metadata-java/blob/master/tests/src/test/java/org/signal/libsignal/metadata/SessionCipherTest.java
// public class SessionCipherTest extends TestCase {
class SMKSessionCipherTest: SignalBaseTest {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
// public void testBasicSessionV3()
// throws InvalidKeyException, DuplicateMessageException,
// LegacyMessageException, InvalidMessageException, NoSuchAlgorithmException, NoSessionException, UntrustedIdentityException
func testBasicSessionV3() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+14159999999", deviceId: 1, registrationId: 1234)
let bobMockClient = MockClient(recipientId: "+14158888888", deviceId: 1, registrationId: 1235)
// SessionRecord aliceSessionRecord = new SessionRecord();
// SessionRecord bobSessionRecord = new SessionRecord();
let aliceSessionRecord = SessionRecord()!
let bobSessionRecord = SessionRecord()!
// initializeSessionsV3(aliceSessionRecord.getSessionState(), bobSessionRecord.getSessionState());
initializeSessionsV3(aliceSessionState: aliceSessionRecord.sessionState()!,
bobSessionState: bobSessionRecord.sessionState()!,
aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
// runInteraction(aliceSessionRecord, bobSessionRecord);
runInteraction(aliceSessionRecord: aliceSessionRecord,
bobSessionRecord: bobSessionRecord,
aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
}
// public void testMessageKeyLimits() throws Exception {
func testMessageKeyLimits() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+14159999999", deviceId: 1, registrationId: 1234)
let bobMockClient = MockClient(recipientId: "+14158888888", deviceId: 1, registrationId: 1235)
// SessionRecord aliceSessionRecord = new SessionRecord();
// SessionRecord bobSessionRecord = new SessionRecord();
let aliceSessionRecord = SessionRecord()!
let bobSessionRecord = SessionRecord()!
// initializeSessionsV3(aliceSessionRecord.getSessionState(), bobSessionRecord.getSessionState());
initializeSessionsV3(aliceSessionState: aliceSessionRecord.sessionState()!,
bobSessionState: bobSessionRecord.sessionState()!,
aliceMockClient: aliceMockClient,
bobMockClient: bobMockClient)
// SignalProtocolStore aliceStore = new TestInMemorySignalProtocolStore();
// SignalProtocolStore bobStore = new TestInMemorySignalProtocolStore();
//
// aliceStore.storeSession(new SignalProtocolAddress("+14159999999", 1), aliceSessionRecord);
// bobStore.storeSession(new SignalProtocolAddress("+14158888888", 1), bobSessionRecord);
aliceMockClient.sessionStore.storeSession(aliceMockClient.recipientId, deviceId: aliceMockClient.deviceId, session: aliceSessionRecord, protocolContext: nil)
bobMockClient.sessionStore.storeSession(bobMockClient.recipientId, deviceId: bobMockClient.deviceId, session: bobSessionRecord, protocolContext: nil)
// SessionCipher aliceCipher = new SessionCipher(aliceStore, new SignalProtocolAddress("+14159999999", 1));
// SessionCipher bobCipher = new SessionCipher(bobStore, new SignalProtocolAddress("+14158888888", 1));
let aliceCipher = aliceMockClient.createSessionCipher()
let bobCipher = bobMockClient.createSessionCipher()
// List<CiphertextMessage> inflight = new LinkedList<>();
var inflight = [CipherMessage]()
// for (int i=0;i<2010;i++) {
// inflight.add(aliceCipher.encrypt("you've never been so hungry, you've never been so cold".getBytes()));
// }
for _ in 1...2010 {
let plaintext = "you've never been so hungry, you've never been so cold".data(using: String.Encoding.utf8)!
let message = aliceCipher.encryptMessage(plaintext, protocolContext: nil)
inflight.append(message)
}
// bobCipher.decrypt(new SignalMessage(inflight.get(1000).serialize()));
// bobCipher.decrypt(new SignalMessage(inflight.get(inflight.size()-1).serialize()));
let midpointMessage = bobCipher.decrypt(inflight[1000], protocolContext: nil)
XCTAssertNotNil(midpointMessage)
let lastMessage = bobCipher.decrypt(inflight.last!, protocolContext: nil)
XCTAssertNotNil(lastMessage)
// TODO: Why isn't this failing?
let firstMessage = bobCipher.decrypt(inflight[0], protocolContext: nil)
XCTAssertNotNil(firstMessage)
// try {
// bobCipher.decrypt(new SignalMessage(inflight.get(0).serialize()));
// throw new AssertionError("Should have failed!");
// } catch (DuplicateMessageException dme) {
// // good
// }
}
// MARK: - Utils
// private void runInteraction(SessionRecord aliceSessionRecord, SessionRecord bobSessionRecord)
// throws DuplicateMessageException, LegacyMessageException, InvalidMessageException, NoSuchAlgorithmException, NoSessionException, UntrustedIdentityException {
private func runInteraction(aliceSessionRecord: SessionRecord,
bobSessionRecord: SessionRecord,
aliceMockClient: MockClient,
bobMockClient: MockClient) {
// SignalProtocolStore aliceStore = new TestInMemorySignalProtocolStore();
// SignalProtocolStore bobStore = new TestInMemorySignalProtocolStore();
// aliceStore.storeSession(new SignalProtocolAddress("+14159999999", 1), aliceSessionRecord);
// bobStore.storeSession(new SignalProtocolAddress("+14158888888", 1), bobSessionRecord);
aliceMockClient.sessionStore.storeSession(aliceMockClient.recipientId, deviceId: aliceMockClient.deviceId, session: aliceSessionRecord, protocolContext: nil)
bobMockClient.sessionStore.storeSession(bobMockClient.recipientId, deviceId: bobMockClient.deviceId, session: bobSessionRecord, protocolContext: nil)
// SessionCipher aliceCipher = new SessionCipher(aliceStore, new SignalProtocolAddress("+14159999999", 1));
// SessionCipher bobCipher = new SessionCipher(bobStore, new SignalProtocolAddress("+14158888888", 1));
let aliceCipher = aliceMockClient.createSessionCipher()
let bobCipher = bobMockClient.createSessionCipher()
// byte[] alicePlaintext = "This is a plaintext message.".getBytes();
let alicePlaintext = "This is a plaintext message.".data(using: String.Encoding.utf8)!
// TODO: Why isn't the java test padding the plaintext?
let alicePaddedPlaintext = (alicePlaintext as NSData).paddedMessageBody()!
// CiphertextMessage message = aliceCipher.encrypt(alicePlaintext);
let message = aliceCipher.encryptMessage(alicePaddedPlaintext, protocolContext: nil)
// byte[] bobPlaintext = bobCipher.decrypt(new SignalMessage(message.serialize()));
let bobPaddedPlaintext = bobCipher.decrypt(message, protocolContext: nil)
let bobPlaintext = (bobPaddedPlaintext as NSData).removePadding()
// assertTrue(Arrays.equals(alicePlaintext, bobPlaintext));
XCTAssertEqual(alicePlaintext, bobPlaintext)
// byte[] bobReply = "This is a message from Bob.".getBytes();
let bobReply = "This is a message from Bob.".data(using: String.Encoding.utf8)!
let bobReplyPadded = (bobReply as NSData).paddedMessageBody()!
// CiphertextMessage reply = bobCipher.encrypt(bobReply);
let reply = bobCipher.encryptMessage(bobReplyPadded, protocolContext: nil)
// byte[] receivedReply = aliceCipher.decrypt(new SignalMessage(reply.serialize()));
let receivedReplyPadded = aliceCipher.decrypt(reply, protocolContext: nil)
let receivedReply = (receivedReplyPadded as NSData).removePadding()
// assertTrue(Arrays.equals(bobReply, receivedReply));
XCTAssertEqual(bobReply, receivedReply)
// List<CiphertextMessage> aliceCiphertextMessages = new ArrayList<>();
// List<byte[]> alicePlaintextMessages = new ArrayList<>();
typealias MessageTuple = (plaintext: Data, message: CipherMessage)
var aliceMessages = [MessageTuple]()
// for (int i=0;i<50;i++) {
// alicePlaintextMessages.add(("смерть за смерть " + i).getBytes());
// aliceCiphertextMessages.add(aliceCipher.encrypt(("смерть за смерть " + i).getBytes()));
for i in 1...50 {
let plaintext = "смерть за смерть \(i)".data(using: String.Encoding.utf8)!
let message = aliceCipher.encryptMessage(plaintext, protocolContext: nil)
aliceMessages.append((plaintext:plaintext, message:message))
}
// long seed = System.currentTimeMillis();
//
// Collections.shuffle(aliceCiphertextMessages, new Random(seed));
// Collections.shuffle(alicePlaintextMessages, new Random(seed));
aliceMessages = aliceMessages.shuffled()
// for (int i=0;i<aliceCiphertextMessages.size() / 2;i++) {
// byte[] receivedPlaintext = bobCipher.decrypt(new SignalMessage(aliceCiphertextMessages.get(i).serialize()));
// assertTrue(Arrays.equals(receivedPlaintext, alicePlaintextMessages.get(i)));
// }
let alicePivot = aliceMessages.count / 2
let aliceMessagesLeft = aliceMessages[0 ..< alicePivot]
let aliceMessagesRight = aliceMessages[alicePivot ..< aliceMessages.count]
for (plaintext, message) in aliceMessagesLeft {
let receivedPlaintext = bobCipher.decrypt(message, protocolContext: nil)
XCTAssertEqual(plaintext, receivedPlaintext)
}
// List<CiphertextMessage> bobCiphertextMessages = new ArrayList<>();
// List<byte[]> bobPlaintextMessages = new ArrayList<>();
var bobMessages = [MessageTuple]()
// for (int i=0;i<20;i++) {
// bobPlaintextMessages.add(("смерть за смерть " + i).getBytes());
// bobCiphertextMessages.add(bobCipher.encrypt(("смерть за смерть " + i).getBytes()));
// }
for i in 1...20 {
let plaintext = "смерть за смерть \(i)".data(using: String.Encoding.utf8)!
let message = bobCipher.encryptMessage(plaintext, protocolContext: nil)
bobMessages.append((plaintext:plaintext, message:message))
}
// seed = System.currentTimeMillis();
//
// Collections.shuffle(bobCiphertextMessages, new Random(seed));
// Collections.shuffle(bobPlaintextMessages, new Random(seed));
bobMessages = bobMessages.shuffled()
// for (int i=0;i<bobCiphertextMessages.size() / 2;i++) {
// byte[] receivedPlaintext = aliceCipher.decrypt(new SignalMessage(bobCiphertextMessages.get(i).serialize()));
// assertTrue(Arrays.equals(receivedPlaintext, bobPlaintextMessages.get(i)));
// }
let bobPivot = bobMessages.count / 2
let bobMessagesLeft = bobMessages[0 ..< bobPivot]
let bobMessagesRight = bobMessages[bobPivot ..< bobMessages.count]
for (plaintext, message) in bobMessagesLeft {
let receivedPlaintext = aliceCipher.decrypt(message, protocolContext: nil)
XCTAssertEqual(plaintext, receivedPlaintext)
}
// for (int i=aliceCiphertextMessages.size()/2;i<aliceCiphertextMessages.size();i++) {
// byte[] receivedPlaintext = bobCipher.decrypt(new SignalMessage(aliceCiphertextMessages.get(i).serialize()));
// assertTrue(Arrays.equals(receivedPlaintext, alicePlaintextMessages.get(i)));
// }
for (plaintext, message) in aliceMessagesRight {
let receivedPlaintext = bobCipher.decrypt(message, protocolContext: nil)
XCTAssertEqual(plaintext, receivedPlaintext)
}
//
// for (int i=bobCiphertextMessages.size() / 2;i<bobCiphertextMessages.size(); i++) {
// byte[] receivedPlaintext = aliceCipher.decrypt(new SignalMessage(bobCiphertextMessages.get(i).serialize()));
// assertTrue(Arrays.equals(receivedPlaintext, bobPlaintextMessages.get(i)));
// }
for (plaintext, message) in bobMessagesRight {
let receivedPlaintext = aliceCipher.decrypt(message, protocolContext: nil)
XCTAssertEqual(plaintext, receivedPlaintext)
}
}
// private void initializeSessionsV3(SessionState aliceSessionState, SessionState bobSessionState)
// throws InvalidKeyException
// {
private func initializeSessionsV3(aliceSessionState: SessionState,
bobSessionState: SessionState,
aliceMockClient: MockClient,
bobMockClient: MockClient) {
// ECKeyPair aliceIdentityKeyPair = Curve.generateKeyPair();
let aliceIdentityKeyPair = aliceMockClient.identityKeyPair
// IdentityKeyPair aliceIdentityKey = new IdentityKeyPair(new IdentityKey(aliceIdentityKeyPair.getPublicKey()),
// aliceIdentityKeyPair.getPrivateKey());
// TODO: Is this necessary?
let aliceIdentityKey = aliceIdentityKeyPair
// ECKeyPair aliceBaseKey = Curve.generateKeyPair();
let aliceBaseKey = Curve25519.generateKeyPair()
// ECKeyPair aliceEphemeralKey = Curve.generateKeyPair();
// NOTE: aliceEphemeralKey isn't used.
// ECKeyPair alicePreKey = aliceBaseKey;
// NOTE: alicePreKey isn't used.
// ECKeyPair bobIdentityKeyPair = Curve.generateKeyPair();
let bobIdentityKeyPair = bobMockClient.identityKeyPair
// IdentityKeyPair bobIdentityKey = new IdentityKeyPair(new IdentityKey(bobIdentityKeyPair.getPublicKey()),
// bobIdentityKeyPair.getPrivateKey());
// TODO: Is this necessary?
let bobIdentityKey = bobIdentityKeyPair
// ECKeyPair bobBaseKey = Curve.generateKeyPair();
let bobBaseKey = Curve25519.generateKeyPair()
// ECKeyPair bobEphemeralKey = bobBaseKey;
let bobEphemeralKey = bobBaseKey
// ECKeyPair bobPreKey = Curve.generateKeyPair();
// NOTE: bobPreKey isn't used.
// AliceSignalProtocolParameters aliceParameters = AliceSignalProtocolParameters.newBuilder()
// .setOurBaseKey(aliceBaseKey)
// .setOurIdentityKey(aliceIdentityKey)
// .setTheirOneTimePreKey(Optional.<ECPublicKey>absent())
// .setTheirRatchetKey(bobEphemeralKey.getPublicKey())
// .setTheirSignedPreKey(bobBaseKey.getPublicKey())
// .setTheirIdentityKey(bobIdentityKey.getPublicKey())
// .create();
let aliceParameters = AliceAxolotlParameters(identityKey: aliceIdentityKey,
theirIdentityKey: bobIdentityKey.publicKey,
ourBaseKey: aliceBaseKey,
theirSignedPreKey: bobBaseKey.publicKey,
theirOneTimePreKey: nil,
theirRatchetKey: bobEphemeralKey.publicKey)
// BobSignalProtocolParameters bobParameters = BobSignalProtocolParameters.newBuilder()
// .setOurRatchetKey(bobEphemeralKey)
// .setOurSignedPreKey(bobBaseKey)
// .setOurOneTimePreKey(Optional.<ECKeyPair>absent())
// .setOurIdentityKey(bobIdentityKey)
// .setTheirIdentityKey(aliceIdentityKey.getPublicKey())
// .setTheirBaseKey(aliceBaseKey.getPublicKey())
// .create();
let bobParameters = BobAxolotlParameters(myIdentityKeyPair: bobIdentityKey,
theirIdentityKey: aliceIdentityKey.publicKey,
ourSignedPrekey: bobBaseKey,
ourRatchetKey: bobEphemeralKey,
ourOneTimePrekey: nil,
theirBaseKey: aliceBaseKey.publicKey)
// TODO: We could expose this constant in SessionBuilder.h.
let currentVersion: Int32 = 3
// RatchetingSession.initializeSession(aliceSessionState, aliceParameters);
RatchetingSession.initializeSession(aliceSessionState, sessionVersion: currentVersion, aliceParameters: aliceParameters)
// RatchetingSession.initializeSession(bobSessionState, bobParameters);
RatchetingSession.initializeSession(bobSessionState, sessionVersion: currentVersion, bobParameters: bobParameters)
}
}

167
SignalMetadataKitTests/src/SMKTest.swift Normal file
View File

@ -0,0 +1,167 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
class SMKMiscTest: SignalBaseTest {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
func testECPrivateKey() {
let keyData = Randomness.generateRandomBytes(Int32(ECCKeyLength))!
let key = try! ECPrivateKey(keyData: keyData)
let key2 = try! ECPrivateKey(keyData: keyData)
XCTAssertEqual(key, key2)
}
func testECPublicKey() {
let keyData = Randomness.generateRandomBytes(Int32(ECCKeyLength))!
let key = try! ECPublicKey(rawKeyData: keyData)
XCTAssertEqual(key.keyData, keyData)
let serializedData = key.serialized
let parsedKey = try! ECPublicKey(serializedKeyData: serializedData)
XCTAssertEqual(parsedKey.keyData, keyData)
XCTAssertEqual(key, parsedKey)
}
func testUDMessage() {
let keyData = Randomness.generateRandomBytes(Int32(ECCKeyLength))!
let ephemeralKey = try! ECPublicKey(rawKeyData: keyData)
let encryptedStatic = Randomness.generateRandomBytes(100)!
let encryptedMessage = Randomness.generateRandomBytes(200)!
let message = SMKUnidentifiedSenderMessage(ephemeralKey: ephemeralKey,
encryptedStatic: encryptedStatic,
encryptedMessage: encryptedMessage)
let messageData = try! message.serialized()
let parsedMessage = try! SMKUnidentifiedSenderMessage.parse(dataAndPrefix: messageData)
XCTAssertEqual(message.cipherTextVersion, parsedMessage.cipherTextVersion)
XCTAssertEqual(message.ephemeralKey.keyData, parsedMessage.ephemeralKey.keyData)
XCTAssertEqual(message.encryptedStatic, parsedMessage.encryptedStatic)
XCTAssertEqual(message.encryptedMessage, parsedMessage.encryptedMessage)
}
func testUDServerCertificate() {
let keyId: UInt32 = 123
let key = try! ECPublicKey(rawKeyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!)
let signatureData = Randomness.generateRandomBytes(100)!
let serverCertificate = SMKServerCertificate(keyId: keyId,
key: key,
signatureData: signatureData)
let serializedData = try! serverCertificate.serialized()
let parsed = try! SMKServerCertificate.parse(data: serializedData)
XCTAssertEqual(serverCertificate.keyId, parsed.keyId)
XCTAssertEqual(serverCertificate.key, parsed.key)
XCTAssertEqual(serverCertificate.signatureData, parsed.signatureData)
}
func testUDSenderCertificate() {
let serverCertificate = SMKServerCertificate(keyId: 123,
key: try! ECPublicKey(rawKeyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
signatureData: Randomness.generateRandomBytes(100)!)
let key = try! ECPublicKey(rawKeyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!)
let senderDeviceId: UInt32 = 456
let senderRecipientId = "+13213214321"
let expirationTimestamp: UInt64 = 789
let signatureData = Randomness.generateRandomBytes(100)!
let senderCertificate = SMKSenderCertificate(serverCertificate: serverCertificate,
key: key,
senderDeviceId: senderDeviceId,
senderRecipientId: senderRecipientId,
expirationTimestamp: expirationTimestamp,
signatureData: signatureData)
let serializedData = try! senderCertificate.serialized()
let parsed = try! SMKSenderCertificate.parse(data: serializedData)
XCTAssertEqual(senderCertificate.serverCertificate, parsed.serverCertificate)
XCTAssertEqual(senderCertificate.key, parsed.key)
XCTAssertEqual(senderCertificate.senderDeviceId, parsed.senderDeviceId)
XCTAssertEqual(senderCertificate.senderRecipientId, parsed.senderRecipientId)
XCTAssertEqual(senderCertificate.expirationTimestamp, parsed.expirationTimestamp)
XCTAssertEqual(senderCertificate.signatureData, parsed.signatureData)
}
func testUDMessageContent() {
let serverCertificate = SMKServerCertificate(keyId: 123,
key: try! ECPublicKey(rawKeyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
signatureData: Randomness.generateRandomBytes(100)!)
let senderCertificate = SMKSenderCertificate(serverCertificate: serverCertificate,
key: try! ECPublicKey(rawKeyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
senderDeviceId: 456,
senderRecipientId: "+13213214321",
expirationTimestamp: 789,
signatureData: Randomness.generateRandomBytes(100)!)
let contentData = Randomness.generateRandomBytes(200)!
let message = SMKUnidentifiedSenderMessageContent(messageType: .whisper,
senderCertificate: senderCertificate,
contentData: contentData)
let messageData = try! message.serialized()
let parsed = try! SMKUnidentifiedSenderMessageContent.parse(data: messageData)
XCTAssertEqual(message.messageType, parsed.messageType)
XCTAssertEqual(message.senderCertificate, parsed.senderCertificate)
XCTAssertEqual(message.contentData, parsed.contentData)
}
func testUDSessionCipher_encrypt() {
// NOTE: We use MockClient to ensure consistency between of our session state.
let aliceMockClient = MockClient(recipientId: "+13213214321", deviceId: 456, registrationId: 123)
let bobMockClient = MockClient(recipientId: "+13213214322", deviceId: 321, registrationId: 512)
let certificateValidator = MockCertificateValidator()
let bobPrekey = bobMockClient.preKeyStore.createKey()
let bobSignedPrekey = bobMockClient.signedPreKeyStore.createKey()
let bobPreKeyBundle = PreKeyBundle(registrationId: bobMockClient.registrationId,
deviceId: bobMockClient.deviceId,
preKeyId: bobPrekey.id,
preKeyPublic: try! bobPrekey.keyPair.ecPublicKey().serialized,
signedPreKeyPublic: try! bobSignedPrekey.keyPair.ecPublicKey().serialized,
signedPreKeyId: bobSignedPrekey.id,
signedPreKeySignature: bobSignedPrekey.signature,
identityKey: try! bobMockClient.identityKeyPair.ecPublicKey().serialized)!
let aliceToBobSessionBuilder = aliceMockClient.createSessionBuilder(forRecipient: bobMockClient)
aliceToBobSessionBuilder.processPrekeyBundle(bobPreKeyBundle, protocolContext: nil)
let aliceToBobCipher = try! aliceMockClient.createSecretSessionCipher()
let plaintext = Randomness.generateRandomBytes(200)!
let paddedPlaintext = (plaintext as NSData).paddedMessageBody()!
let serverCertificate = SMKServerCertificate(keyId: 123,
key: try! ECPublicKey(rawKeyData: Randomness.generateRandomBytes(Int32(ECCKeyLength))!),
signatureData: Randomness.generateRandomBytes(100)!)
let senderCertificate = SMKSenderCertificate(serverCertificate: serverCertificate,
key: try! aliceMockClient.identityKeyPair.ecPublicKey(),
senderDeviceId: UInt32(aliceMockClient.deviceId),
senderRecipientId: aliceMockClient.recipientId,
expirationTimestamp: 789,
signatureData: Randomness.generateRandomBytes(100)!)
let encryptedMessage = try! aliceToBobCipher.encryptMessage(recipientId: bobMockClient.recipientId,
deviceId: bobMockClient.deviceId,
paddedPlaintext: paddedPlaintext, senderCertificate: senderCertificate, protocolContext: nil)
let messageTimestamp = NSDate.ows_millisecondTimeStamp()
let bobToAliceCipher = try! bobMockClient.createSecretSessionCipher()
let decryptedMessage = try! bobToAliceCipher.decryptMessage(certificateValidator: certificateValidator, cipherTextData: encryptedMessage, timestamp: messageTimestamp, protocolContext: nil)
let payload = (decryptedMessage.paddedPayload as NSData).removePadding()
XCTAssertEqual(aliceMockClient.recipientId, decryptedMessage.senderRecipientId)
XCTAssertEqual(aliceMockClient.deviceId, Int32(decryptedMessage.senderDeviceId))
XCTAssertEqual(plaintext, payload)
}
}

253
SignalMetadataKitTests/src/SMKTestUtils.swift Normal file
View File

@ -0,0 +1,253 @@
//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
class MockCertificateValidator: NSObject, SMKCertificateValidator {
@objc public func validate(senderCertificate: SMKSenderCertificate, validationTime: UInt64) throws {
// Do not throw
}
@objc public func validate(serverCertificate: SMKServerCertificate) throws {
// Do not throw
}
}
// MARK: -
class MockIdentityStore: NSObject, IdentityKeyStore {
private let localIdentityKeyPair: ECKeyPair?
private let localRegistrationId: Int32
private var identityKeyMap = [String: Data]()
init(localIdentityKeyPair: ECKeyPair?, localRegistrationId: Int32) {
self.localIdentityKeyPair = localIdentityKeyPair
self.localRegistrationId = localRegistrationId
}
public func identityKeyPair(_ protocolContext: Any?) -> ECKeyPair? {
return localIdentityKeyPair
}
public func localRegistrationId(_ protocolContext: Any?) -> Int32 {
return localRegistrationId
}
// @returns YES if we are replacing an existing known identity key for recipientId.
// NO if there was no previously stored identity key for the recipient.
public func saveRemoteIdentity(_ identityKey: Data, recipientId: String, protocolContext: Any?) -> Bool {
let didReplace = identityKeyMap[recipientId] != nil
identityKeyMap[recipientId] = identityKey
return didReplace
}
public func isTrustedIdentityKey(_ identityKey: Data, recipientId: String, direction: TSMessageDirection, protocolContext: Any?) -> Bool {
return true
}
public func identityKey(forRecipientId recipientId: String) -> Data? {
if let identityKey = identityKeyMap[recipientId] {
return identityKey
}
let identityKey = Randomness.generateRandomBytes(100)!
identityKeyMap[recipientId] = identityKey
return identityKey
}
public func identityKey(forRecipientId recipientId: String, protocolContext: Any?) -> Data? {
return identityKey(forRecipientId: recipientId)
}
}
// MARK: -
private class MockSessionKey: NSObject {
let contactIdentifier: String
let deviceId: Int32
init(contactIdentifier: String, deviceId: Int32) {
self.contactIdentifier = contactIdentifier
self.deviceId = deviceId
}
open override func isEqual(_ other: Any?) -> Bool {
if let other = other as? MockSessionKey {
return contactIdentifier == other.contactIdentifier && deviceId == other.deviceId
} else {
return false
}
}
public override var hash: Int {
return contactIdentifier.hashValue ^ deviceId.hashValue
}
}
// MARK: -
class MockSessionStore: NSObject, SessionStore {
private var sessionMap = [MockSessionKey: SessionRecord]()
public func loadSession(_ contactIdentifier: String, deviceId: Int32, protocolContext: Any?) -> SessionRecord {
let sessionKey = MockSessionKey(contactIdentifier: contactIdentifier, deviceId: deviceId)
if let sessionRecord = sessionMap[sessionKey] {
return sessionRecord
}
let sessionRecord = SessionRecord()!
return sessionRecord
}
public func subDevicesSessions(_ contactIdentifier: String, protocolContext: Any?) -> [Any] {
notImplemented()
}
public func storeSession(_ contactIdentifier: String, deviceId: Int32, session: SessionRecord, protocolContext: Any?) {
let sessionKey = MockSessionKey(contactIdentifier: contactIdentifier, deviceId: deviceId)
sessionMap[sessionKey] = session
}
public func containsSession(_ contactIdentifier: String, deviceId: Int32, protocolContext: Any?) -> Bool {
return self.loadSession(contactIdentifier, deviceId: deviceId, protocolContext: protocolContext).sessionState().hasSenderChain()
}
public func deleteSession(forContact contactIdentifier: String, deviceId: Int32, protocolContext: Any?) {
let sessionKey = MockSessionKey(contactIdentifier: contactIdentifier, deviceId: deviceId)
sessionMap.removeValue(forKey: sessionKey)
}
public func deleteAllSessions(forContact contactIdentifier: String, protocolContext: Any?) {
sessionMap.removeAll()
}
}
// MARK: -
class MockPreKeyStore: NSObject, PreKeyStore {
private var keyMap = [Int32: PreKeyRecord]()
func createKey() -> PreKeyRecord {
let preKeyId: Int32 = Int32(arc4random_uniform(UInt32(INT32_MAX)))
let keyPair = Curve25519.generateKeyPair()
let preKey = PreKeyRecord(id: preKeyId, keyPair: keyPair)!
keyMap[preKeyId] = preKey
return preKey
}
public func loadPreKey(_ preKeyId: Int32) -> PreKeyRecord {
return keyMap[preKeyId]!
}
public func storePreKey(_ preKeyId: Int32, preKeyRecord record: PreKeyRecord) {
notImplemented()
}
public func containsPreKey(_ preKeyId: Int32) -> Bool {
notImplemented()
}
public func removePreKey(_ preKeyId: Int32) {
notImplemented()
}
}
// MARK: -
class MockSignedPreKeyStore: NSObject, SignedPreKeyStore {
let identityKeyPair: ECKeyPair
init(identityKeyPair: ECKeyPair) {
self.identityKeyPair = identityKeyPair
}
private var keyMap = [Int32: SignedPreKeyRecord]()
func createKey() -> SignedPreKeyRecord {
let signedPreKeyId: Int32 = Int32(arc4random_uniform(UInt32(INT32_MAX)))
let keyPair = Curve25519.generateKeyPair()
let generatedAt = Date()
let signature = Ed25519.sign((keyPair.publicKey as NSData).prependKeyType() as Data, with: identityKeyPair)
let signedPreKey = SignedPreKeyRecord(id: signedPreKeyId, keyPair: keyPair, signature: signature, generatedAt: generatedAt)!
keyMap[signedPreKeyId] = signedPreKey
return signedPreKey
}
public func loadSignedPrekey(_ signedPreKeyId: Int32) -> SignedPreKeyRecord {
return keyMap[signedPreKeyId]!
}
public func loadSignedPrekeyOrNil(_ signedPreKeyId: Int32) -> SignedPreKeyRecord? {
notImplemented()
}
public func loadSignedPreKeys() -> [SignedPreKeyRecord] {
notImplemented()
}
public func storeSignedPreKey(_ signedPreKeyId: Int32, signedPreKeyRecord: SignedPreKeyRecord) {
notImplemented()
}
public func containsSignedPreKey(_ signedPreKeyId: Int32) -> Bool {
notImplemented()
}
public func removeSignedPreKey(_ signedPrekeyId: Int32) {
notImplemented()
}
}
// MARK: -
class MockClient: NSObject {
let recipientId: String
let deviceId: Int32
let registrationId: Int32
let identityKeyPair: ECKeyPair
let sessionStore: MockSessionStore
let preKeyStore: MockPreKeyStore
let signedPreKeyStore: MockSignedPreKeyStore
let identityStore: MockIdentityStore
init(recipientId: String, deviceId: Int32, registrationId: Int32) {
self.recipientId = recipientId
self.deviceId = deviceId
self.registrationId = registrationId
identityKeyPair = Curve25519.generateKeyPair()
sessionStore = MockSessionStore()
preKeyStore = MockPreKeyStore()
signedPreKeyStore = MockSignedPreKeyStore(identityKeyPair: identityKeyPair)
identityStore = MockIdentityStore(localIdentityKeyPair: identityKeyPair, localRegistrationId: registrationId)
}
func createSessionCipher() -> SessionCipher {
return SessionCipher(sessionStore: sessionStore,
preKeyStore: preKeyStore,
signedPreKeyStore: signedPreKeyStore,
identityKeyStore: identityStore,
recipientId: recipientId,
deviceId: deviceId)
}
func createSecretSessionCipher() throws -> SMKSecretSessionCipher {
return try SMKSecretSessionCipher(sessionStore: sessionStore,
preKeyStore: preKeyStore,
signedPreKeyStore: signedPreKeyStore,
identityStore: identityStore)
}
func createSessionBuilder(forRecipient recipient: MockClient) -> SessionBuilder {
return SessionBuilder(sessionStore: sessionStore,
preKeyStore: preKeyStore,
signedPreKeyStore: signedPreKeyStore,
identityKeyStore: identityStore,
recipientId: recipient.recipientId,
deviceId: recipient.deviceId)
}
}

14
protobuf/Makefile Normal file
View File

@ -0,0 +1,14 @@
# See README.md in this dir for prerequisite setup.
PROTOC=protoc \
--proto_path='./'
WRAPPER_SCRIPT=../../Signal-iOS/Scripts/ProtoWrappers.py \
--proto-dir='./' --verbose
all: unidentified_delivery_protos
unidentified_delivery_protos: OWSUnidentifiedDelivery.proto
$(PROTOC) --swift_out=../SignalMetadataKit/src/Generated \
OWSUnidentifiedDelivery.proto
$(WRAPPER_SCRIPT) --dst-dir=../SignalMetadataKit/src/Generated \
--wrapper-prefix=SMKProto --proto-prefix=SMKProtos --proto-file=OWSUnidentifiedDelivery.proto

72
protobuf/OWSUnidentifiedDelivery.proto Normal file
View File

@ -0,0 +1,72 @@
/**
* Copyright (C) 2014-2016 Open Whisper Systems
*
* Licensed according to the LICENSE file in this repository.
*/
// iOS - since we use a modern proto-compiler, we must specify
// the legacy proto format.
syntax = "proto2";
// iOS - package name determines class prefix
package SMKProtos;
option java_package = "org.signal.libsignal.metadata";
option java_outer_classname = "SignalProtos";
message ServerCertificate {
message Certificate {
// @required
optional uint32 id = 1;
// @required
optional bytes key = 2;
}
// @required
optional bytes certificate = 1;
// @required
optional bytes signature = 2;
}
message SenderCertificate {
message Certificate {
// @required
optional string sender = 1;
// @required
optional uint32 senderDevice = 2;
// @required
optional fixed64 expires = 3;
// @required
optional bytes identityKey = 4;
// @required
optional ServerCertificate signer = 5;
}
// @required
optional bytes certificate = 1;
// @required
optional bytes signature = 2;
}
message UnidentifiedSenderMessage {
message Message {
enum Type {
PREKEY_MESSAGE = 1;
MESSAGE = 2;
}
// @required
optional Type type = 1;
// @required
optional SenderCertificate senderCertificate = 2;
// @required
optional bytes content = 3;
}
// @required
optional bytes ephemeralPublic = 1;
// @required
optional bytes encryptedStatic = 2;
// @required
optional bytes encryptedMessage = 3;
}

22
protobuf/README.md Normal file
View File

@ -0,0 +1,22 @@
# SignalServiceKit Protobufs
These protobuf definitions are copied from Signal-Android, but modified
to match some iOS conventions.
## Prequisites
Install Apple's `swift-protobuf` (*not* the similarly named `protobuf-swift`)
brew install swift-protobuf
This should install an up to date protobuf package as a dependency. Note that
since we use the legacy proto2 format, we need to specify this in our .proto
files.
syntax = "proto2";
## Building Protobuf
cd ~/src/WhisperSystems/SignalServiceKit/protobuf
make