initial tests and drafts master
authorKonrad Rosenbaum <konrad@silmor.de>
Wed, 19 Nov 2014 21:42:23 +0000 (22:42 +0100)
committerKonrad Rosenbaum <konrad@silmor.de>
Wed, 19 Nov 2014 21:42:23 +0000 (22:42 +0100)
26 files changed:
.gitignore [new file with mode: 0644]
.gitmodules [new file with mode: 0644]
COPYING.GPL [new file with mode: 0644]
COPYING.MIT [new file with mode: 0644]
README [new file with mode: 0644]
daemon/hidtoken/u2f.h [new file with mode: 0644]
daemon/hidtoken/u2f_hid.h [new file with mode: 0644]
doc/arch-diagram.odg [new file with mode: 0644]
doc/arch-diagram.png [new file with mode: 0644]
doc/gpl3.html [new file with mode: 0644]
doc/index.html [new file with mode: 0644]
doc/mit.html [new file with mode: 0644]
hidapi [new submodule]
libfido/libfido.h [new file with mode: 0644]
testapp/Makefile [new file with mode: 0644]
testapp/fidodevice.c [new file with mode: 0644]
testapp/fidodevice.h [new file with mode: 0644]
testapp/hidapi_report.c [new file with mode: 0644]
testapp/hidapi_report.h [new file with mode: 0644]
testapp/hidapi_usage.c [new file with mode: 0644]
testapp/hidapi_usage.h [new file with mode: 0644]
testapp/main.c [new file with mode: 0644]
testapp/scanfordev.c [new file with mode: 0644]
testapp/scanfordev.h [new file with mode: 0644]
testapp/u2f.h [new file with mode: 0644]
testapp/u2f_hid.h [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..c6ce447
--- /dev/null
@@ -0,0 +1,4 @@
+*.o
+*.obj
+moc_*
+testapp/testapp
diff --git a/.gitmodules b/.gitmodules
new file mode 100644 (file)
index 0000000..340344d
--- /dev/null
@@ -0,0 +1,3 @@
+[submodule "hidapi"]
+       path = hidapi
+       url = git://github.com/signal11/hidapi.git
diff --git a/COPYING.GPL b/COPYING.GPL
new file mode 100644 (file)
index 0000000..4432540
--- /dev/null
@@ -0,0 +1,676 @@
+
+                   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
+
+           How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
diff --git a/COPYING.MIT b/COPYING.MIT
new file mode 100644 (file)
index 0000000..bca296b
--- /dev/null
@@ -0,0 +1,19 @@
+Copyright (c) 2014 Konrad Rosenbaum <konrad@silmor.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
\ No newline at end of file
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..d3cc507
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+README for FIDO Tools
+======================
+
+(c) Konrad Rosenbaum <konrad@silmor.de>, 2014
+FIDO tools are protected under the GPL version 3 or at your option any newer,
+see COPYING.GPL for details.
+As an exception libfido is protected under the much more permissive MIT
+license, see COPYING.MIT for details.
+
+FIDO Tools provide local facilities to interface with FIDO second factor
+authentication tokens.
+
+WARNING
+--------
+
+THIS IS WORK IN PROGRESS IN ITS EARLIEST STAGES.
+DO NOT EXPECT IT TO DO ANYTHING USEFUL OR EVEN HARMLESS!
+IT MAY EVEN CRASH YOUR TOKEN OR EAT YOUR SYSTEM.
+
+Documentation
+--------------
+
+See doc/index.html for instructions on how to use and build FIDO tools.
+
+
+Preliminary Tests
+------------------
+
+The testapp directory contains code for testing out features - it is not
+very functional or supposed to be part of the final product.
diff --git a/daemon/hidtoken/u2f.h b/daemon/hidtoken/u2f.h
new file mode 100644 (file)
index 0000000..6d447c2
--- /dev/null
@@ -0,0 +1,103 @@
+// Common U2F raw message format header - Review Draft
+// 2014-10-08
+// Editor: Jakob Ehrensvard, Yubico, jakob@yubico.com
+
+#ifndef __U2F_H_INCLUDED__
+#define __U2F_H_INCLUDED__
+
+#ifdef _MSC_VER // Windows
+typedef unsigned char uint8_t;
+typedef unsigned short uint16_t;
+typedef unsigned int uint32_t;
+typedef unsigned long int uint64_t;
+#else
+#include <stdint.h>
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// General constants
+#define U2F_EC_KEY_SIZE 32 // EC key size in bytes
+#define U2F_EC_POINT_SIZE ((U2F_EC_KEY_SIZE * 2) + 1) // Size of EC point
+#define U2F_MAX_KH_SIZE 128 // Max size of key handle
+#define U2F_MAX_ATT_CERT_SIZE 2048 // Max size of attestation certificate
+#define U2F_MAX_EC_SIG_SIZE 72 // Max size of DER coded EC signature
+#define U2F_CTR_SIZE 4 // Size of counter field
+#define U2F_APPID_SIZE 32 // Size of application id
+#define U2F_CHAL_SIZE 32 // Size of challenge
+
+#define ENC_SIZE(x) ((x + 7)& 0xfff8)
+
+// EC (uncompressed) point
+
+#define U2F_POINT_UNCOMPRESSED 0x04 // Uncompressed point format
+
+typedef struct {
+        uint8_t pointFormat; // Point type
+        uint8_t x[U2F_EC_KEY_SIZE]; // X-value
+        uint8_t y[U2F_EC_KEY_SIZE]; // Y-value
+} U2F_EC_POINT;
+
+// U2F native commands
+#define U2F_REGISTER 0x01 // Registration command
+#define U2F_AUTHENTICATE 0x02 // Authenticate/sign command
+#define U2F_VERSION 0x03 // Read version string command
+
+#define U2F_VENDOR_FIRST 0xc0 // First vendor defined command
+#define U2F_VENDOR_LAST 0xff // Last vendor defined command
+
+// U2F_CMD_REGISTER command defines
+
+#define U2F_REGISTER_ID 0x05 // Version 2 registration identifier
+#define U2F_REGISTER_HASH_ID 0x00 // Version 2 hash identintifier
+
+typedef struct {
+        uint8_t chal[U2F_CHAL_SIZE]; // Challenge
+        uint8_t appId[U2F_APPID_SIZE]; // Application id
+} U2F_REGISTER_REQ;
+
+typedef struct {
+        uint8_t registerId; // Registration identifier (U2F_REGISTER_ID_V2)
+        U2F_EC_POINT pubKey; // Generated public key
+        uint8_t keyHandleLen; // Length of key handle
+        uint8_t keyHandleCertSig[
+                U2F_MAX_KH_SIZE + // Key handle
+                U2F_MAX_ATT_CERT_SIZE + // Attestation certificate
+                U2F_MAX_EC_SIG_SIZE]; // Registration signature
+} U2F_REGISTER_RESP;
+
+// U2F_CMD_AUTHENTICATE command defines
+
+// Authentication control byte
+
+#define U2F_AUTH_ENFORCE 0x03 // Enforce user presence and sign
+#define U2F_AUTH_CHECK_ONLY 0x07 // Check only
+#define U2F_AUTH_FLAG_TUP 0x01 // Test of user presence set
+
+typedef struct {
+        uint8_t chal[U2F_CHAL_SIZE]; // Challenge
+        uint8_t appId[U2F_APPID_SIZE]; // Application id
+        uint8_t keyHandleLen; // Length of key handle
+        uint8_t keyHandle[U2F_MAX_KH_SIZE]; // Key handle
+} U2F_AUTHENTICATE_REQ;
+
+typedef struct {
+        uint8_t flags; // U2F_AUTH_FLAG_ values
+        uint8_t ctr[U2F_CTR_SIZE]; // Counter field (big-endian)
+        uint8_t sig[U2F_MAX_EC_SIG_SIZE]; // Signature
+} U2F_AUTHENTICATE_RESP;
+
+// Command status responses
+#define U2F_SW_NO_ERROR 0x9000 // SW_NO_ERROR
+#define U2F_SW_WRONG_DATA 0x6984 // SW_WRONG_DATA
+#define U2F_SW_CONDITIONS_NOT_SATISFIED 0x6985 // SW_CONDITIONS_NOT_SATISFIED
+#define U2F_SW_INS_NOT_SUPPORTED 0x6d00 // SW_INS_NOT_SUPPORTED
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __U2F_H_INCLUDED__
diff --git a/daemon/hidtoken/u2f_hid.h b/daemon/hidtoken/u2f_hid.h
new file mode 100644 (file)
index 0000000..ed7b63a
--- /dev/null
@@ -0,0 +1,129 @@
+// Common U2F HID transport header - Review Draft
+// 2014-10-08
+// Editor: Jakob Ehrensvard, Yubico, jakob@yubico.com
+
+#ifndef __U2FHID_H_INCLUDED__
+#define __U2FHID_H_INCLUDED__
+
+#ifdef _MSC_VER // Windows
+typedef unsigned char uint8_t;
+typedef unsigned short uint16_t;
+typedef unsigned int uint32_t;
+typedef unsigned long int uint64_t;
+#else
+#include <stdint.h>
+#endif
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Size of HID reports
+
+#define HID_RPT_SIZE 64 // Default size of raw HID report
+
+// Frame layout - command- and continuation frames
+
+#define CID_BROADCAST 0xffffffff // Broadcast channel id
+
+#define TYPE_MASK 0x80 // Frame type mask
+#define TYPE_INIT 0x80 // Initial frame identifier
+#define TYPE_CONT 0x00 // Continuation frame identifier
+
+typedef struct {
+        uint32_t cid; // Channel identifier
+        union {
+                uint8_t type; // Frame type - b7 defines type
+                struct {
+                        uint8_t cmd; // Command - b7 set
+                        uint8_t bcnth; // Message byte count - high part
+                        uint8_t bcntl; // Message byte count - low part
+                        uint8_t data[HID_RPT_SIZE - 7]; // Data payload
+                } init;
+                struct {
+                        uint8_t seq; // Sequence number - b7 cleared
+                        uint8_t data[HID_RPT_SIZE - 5]; // Data payload
+                }cont;
+        };
+} U2FHID_FRAME;
+
+#define FRAME_TYPE(f) ((f).type & TYPE_MASK)
+#define FRAME_CMD(f)  ((f).init.cmd & ~TYPE_MASK)
+#define MSG_LEN(f)    ((f).init.bcnth*256 + (f).init.bcntl)
+#define FRAME_SEQ(f)  ((f).cont.seq & ~TYPE_MASK)
+
+// HID usage- and usage-page definitions
+
+#define FIDO_USAGE_PAGE     0xf1d0 // FIDO alliance HID usage page
+#define FIDO_USAGE_U2FHID   0x01   // U2FHID usage for top-level collection
+#define FIDO_USAGE_DATA_IN  0x20   // Raw IN data report
+#define FIDO_USAGE_DATA_OUT 0x21   // Raw OUT data report
+
+// General constants
+
+#define U2FHID_IF_VERSION       2 // Current interface implementation version
+#define U2FHID_TRANS_TIMEOUT 3000 // Default message timeout in ms
+
+// U2FHID native commands
+
+#define U2FHID_PING  (TYPE_INIT | 0x01) // Echo data through local processor only
+#define U2FHID_MSG   (TYPE_INIT | 0x03) // Send U2F message frame
+#define U2FHID_LOCK  (TYPE_INIT | 0x04) // Send lock channel command
+#define U2FHID_INIT  (TYPE_INIT | 0x06) // Channel initialization
+#define U2FHID_WINK  (TYPE_INIT | 0x08) // Send device identification wink
+#define U2FHID_SYNC  (TYPE_INIT | 0x3c) // Protocol resync command
+#define U2FHID_ERROR (TYPE_INIT | 0x3f) // Error response
+
+#define U2FHID_VENDOR_FIRST (TYPE_INIT | 0x40) // First vendor defined command
+#define U2FHID_VENDOR_LAST  (TYPE_INIT | 0x7f) // Last vendor defined command
+
+
+// U2FHID_INIT command defines
+
+#define INIT_NONCE_SIZE 8    // Size of channel initialization challenge
+#define CAPFLAG_WINK    0x01 // Device supports WINK command
+
+
+typedef struct {
+        uint8_t nonce[INIT_NONCE_SIZE]; // Client application nonce
+} U2FHID_INIT_REQ;
+
+typedef struct {
+        uint8_t nonce[INIT_NONCE_SIZE]; // Client application nonce
+        uint32_t cid; // Channel identifier
+        uint8_t versionInterface; // Interface version
+        uint8_t versionMajor; // Major version number
+        uint8_t versionMinor; // Minor version number
+        uint8_t versionBuild; // Build version number
+        uint8_t capFlags; // Capabilities flags
+} U2FHID_INIT_RESP;
+
+// U2FHID_SYNC command defines
+
+typedef struct {
+        uint8_t nonce; // Client application nonce
+} U2FHID_SYNC_REQ;
+
+typedef struct {
+        uint8_t nonce; // Client application nonce
+} U2FHID_SYNC_RESP;
+
+// Low-level error codes. Return as negatives.
+
+#define ERR_NONE          0x00 // No error
+#define ERR_INVALID_CMD   0x01 // Invalid command
+#define ERR_INVALID_PAR   0x02 // Invalid parameter
+#define ERR_INVALID_LEN   0x03 // Invalid message length
+#define ERR_INVALID_SEQ   0x04 // Invalid message sequencing
+#define ERR_MSG_TIMEOUT   0x05 // Message has timed out
+#define ERR_CHANNEL_BUSY  0x06 // Channel busy
+#define ERR_LOCK_REQUIRED 0x0a // Command requires channel lock
+#define ERR_SYNC_FAIL     0x0b // SYNC command failed
+#define ERR_OTHER         0x7f // Other unspecified error
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __U2FHID_H_INCLUDED__
diff --git a/doc/arch-diagram.odg b/doc/arch-diagram.odg
new file mode 100644 (file)
index 0000000..a26c0be
Binary files /dev/null and b/doc/arch-diagram.odg differ
diff --git a/doc/arch-diagram.png b/doc/arch-diagram.png
new file mode 100644 (file)
index 0000000..bc0a040
Binary files /dev/null and b/doc/arch-diagram.png differ
diff --git a/doc/gpl3.html b/doc/gpl3.html
new file mode 100644 (file)
index 0000000..d64890f
--- /dev/null
@@ -0,0 +1,694 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <title>GNU General Public License - GNU Project - Free Software Foundation (FSF)</title>
+ <link rel="alternate" type="application/rdf+xml"
+       href="http://www.gnu.org/licenses/gpl-3.0.rdf" /> 
+</head>
+<body>
+<h3 style="text-align: center;">GNU GENERAL PUBLIC LICENSE</h3>
+<p style="text-align: center;">Version 3, 29 June 2007</p>
+
+<p>Copyright &copy; 2007 Free Software Foundation, Inc.
+ &lt;<a href="http://fsf.org/">http://fsf.org/</a>&gt;</p><p>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.</p>
+
+<h3><a name="preamble"></a>Preamble</h3>
+
+<p>The GNU General Public License is a free, copyleft license for
+software and other kinds of works.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>The precise terms and conditions for copying, distribution and
+modification follow.</p>
+
+<h3><a name="terms"></a>TERMS AND CONDITIONS</h3>
+
+<h4><a name="section0"></a>0. Definitions.</h4>
+
+<p>&ldquo;This License&rdquo; refers to version 3 of the GNU General Public License.</p>
+
+<p>&ldquo;Copyright&rdquo; also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.</p>
+<p>&ldquo;The Program&rdquo; refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as &ldquo;you&rdquo;.  &ldquo;Licensees&rdquo; and
+&ldquo;recipients&rdquo; may be individuals or organizations.</p>
+
+<p>To &ldquo;modify&rdquo; 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 &ldquo;modified version&rdquo; of the
+earlier work or a work &ldquo;based on&rdquo; the earlier work.</p>
+
+<p>A &ldquo;covered work&rdquo; means either the unmodified Program or a work based
+on the Program.</p>
+
+<p>To &ldquo;propagate&rdquo; 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.</p>
+
+<p>To &ldquo;convey&rdquo; 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.</p>
+
+<p>An interactive user interface displays &ldquo;Appropriate Legal Notices&rdquo;
+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.</p>
+
+<h4><a name="section1"></a>1. Source Code.</h4>
+
+<p>The &ldquo;source code&rdquo; for a work means the preferred form of the work
+for making modifications to it.  &ldquo;Object code&rdquo; means any non-source
+form of a work.</p>
+
+<p>A &ldquo;Standard Interface&rdquo; 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.</p>
+
+<p>The &ldquo;System Libraries&rdquo; 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
+&ldquo;Major Component&rdquo;, 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.</p>
+
+<p>The &ldquo;Corresponding Source&rdquo; 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.</p>
+
+<p>The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.</p>
+
+<p>The Corresponding Source for a work in source code form is that
+same work.</p>
+
+<h4><a name="section2"></a>2. Basic Permissions.</h4>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.</p>
+
+<h4><a name="section3"></a>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h4><a name="section4"></a>4. Conveying Verbatim Copies.</h4>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h4><a name="section5"></a>5. Conveying Modified Source Versions.</h4>
+
+<p>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:</p>
+
+<ul>
+<li>a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.</li>
+
+<li>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
+    &ldquo;keep intact all notices&rdquo;.</li>
+
+<li>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.</li>
+
+<li>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.</li>
+</ul>
+
+<p>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
+&ldquo;aggregate&rdquo; 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.</p>
+
+<h4><a name="section6"></a>6. Conveying Non-Source Forms.</h4>
+
+<p>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:</p>
+
+<ul>
+<li>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.</li>
+
+<li>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.</li>
+
+<li>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.</li>
+
+<li>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.</li>
+
+<li>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.</li>
+</ul>
+
+<p>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.</p>
+
+<p>A &ldquo;User Product&rdquo; is either (1) a &ldquo;consumer product&rdquo;, 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, &ldquo;normally used&rdquo; 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.</p>
+
+<p>&ldquo;Installation Information&rdquo; 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.</p>
+
+<p>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).</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h4><a name="section7"></a>7. Additional Terms.</h4>
+
+<p>&ldquo;Additional permissions&rdquo; 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.</p>
+
+<p>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.</p>
+
+<p>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:</p>
+
+<ul>
+<li>a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or</li>
+
+<li>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</li>
+
+<li>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</li>
+
+<li>d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or</li>
+
+<li>e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or</li>
+
+<li>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.</li>
+</ul>
+
+<p>All other non-permissive additional terms are considered &ldquo;further
+restrictions&rdquo; 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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h4><a name="section8"></a>8. Termination.</h4>
+
+<p>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).</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h4><a name="section9"></a>9. Acceptance Not Required for Having Copies.</h4>
+
+<p>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.</p>
+
+<h4><a name="section10"></a>10. Automatic Licensing of Downstream Recipients.</h4>
+
+<p>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.</p>
+
+<p>An &ldquo;entity transaction&rdquo; 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.</p>
+
+<p>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.</p>
+
+<h4><a name="section11"></a>11. Patents.</h4>
+
+<p>A &ldquo;contributor&rdquo; 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 &ldquo;contributor version&rdquo;.</p>
+
+<p>A contributor's &ldquo;essential patent claims&rdquo; 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, &ldquo;control&rdquo; includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.</p>
+
+<p>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.</p>
+
+<p>In the following three paragraphs, a &ldquo;patent license&rdquo; 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 &ldquo;grant&rdquo; such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.</p>
+
+<p>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.  &ldquo;Knowingly relying&rdquo; 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.</p>
+  
+<p>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.</p>
+
+<p>A patent license is &ldquo;discriminatory&rdquo; 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.</p>
+
+<p>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.</p>
+
+<h4><a name="section12"></a>12. No Surrender of Others' Freedom.</h4>
+
+<p>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.</p>
+
+<h4><a name="section13"></a>13. Use with the GNU Affero General Public License.</h4>
+
+<p>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.</p>
+
+<h4><a name="section14"></a>14. Revised Versions of this License.</h4>
+
+<p>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.</p>
+
+<p>Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License &ldquo;or any later version&rdquo; 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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h4><a name="section15"></a>15. Disclaimer of Warranty.</h4>
+
+<p>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 &ldquo;AS IS&rdquo; 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.</p>
+
+<h4><a name="section16"></a>16. Limitation of Liability.</h4>
+
+<p>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.</p>
+
+<h4><a name="section17"></a>17. Interpretation of Sections 15 and 16.</h4>
+
+<p>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.</p>
+
+<p>END OF TERMS AND CONDITIONS</p>
+
+<h3><a name="howto"></a>How to Apply These Terms to Your New Programs</h3>
+
+<p>If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.</p>
+
+<p>To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the &ldquo;copyright&rdquo; line and a pointer to where the full notice is found.</p>
+
+<pre>    &lt;one line to give the program's name and a brief idea of what it does.&gt;
+    Copyright (C) &lt;year&gt;  &lt;name of author&gt;
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.
+</pre>
+
+<p>Also add information on how to contact you by electronic and paper mail.</p>
+
+<p>If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:</p>
+
+<pre>    &lt;program&gt;  Copyright (C) &lt;year&gt;  &lt;name of author&gt;
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+</pre>
+
+<p>The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an &ldquo;about box&rdquo;.</p>
+
+<p>You should also get your employer (if you work as a programmer) or school,
+if any, to sign a &ldquo;copyright disclaimer&rdquo; for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+&lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
+
+<p>The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+&lt;<a href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>&gt;.</p>
+
+</body></html>
diff --git a/doc/index.html b/doc/index.html
new file mode 100644 (file)
index 0000000..b60df14
--- /dev/null
@@ -0,0 +1,42 @@
+<html>
+<title>FIDO Tools</title>
+<body>
+<h1>FIDO Tools</h1>
+
+<p>&copy; Konrad Rosenbaum &lt;konrad@silmor.de>, 2014<br/>
+FIDO tools are protected under the <a href="gpl3.html">GPL version 3</a>, or at your option any newer.<br/>
+As an exception libfido is protected under the much more permissive <a href="mit.html">MIT license</a>.</p>
+
+<p>FIDO Tools provide local facilities to interface with FIDO second factor
+authentication tokens as specified by the <a href="https://fidoalliance.org/">FIDO Alliance</a>.</p>
+
+<h2>Parts of FIDO Tools</h2>
+
+<img src="arch-diagram.png"/><p/>
+
+<p><b>FIDO Daemon</b> - a program working in the background accessing the FIDO tokens, generating, enrolling, and verifying keys and services. It acts as the actual backend for all other utilities.</p>
+
+<p><b>LibFIDO</b> - a thin library layer that is linked into client programs, which accesses the FIDO daemon for the actual work.</p>
+
+<p><b>libQtFido</b> - the Qt5 based version of the library.</p>
+
+<p><b>PAM-FIDO</b> - a PAM module that enables systems to authenticate users against FIDO tokens.</p>
+
+<p><b>FidoCtl</b> - a utility to access all FIDO Daemon functions from scripts. For example to enroll keys for PAM.</p>
+
+<p><b>FidoUi</b> - a GUI to access FIDO functions (based on Qt5 and libQtFido).</p>
+
+<h2>Building and Development</h2>
+
+<ul>
+<li>Building FIDO Tools</li>
+<li>Source Docu:<ul>
+  <li>libFIDO - how to use FIDO Tools in your own programs</li>
+  <li>FIDO Daemon - architecture of the main program</li>
+  <li>PAM-FIDO - the FIDO based PAM module</li>
+  <li>libQtFido - the Qt5 module for FIDO</li>
+  </ul></li>
+</ul>
+
+</body>
+</html>
\ No newline at end of file
diff --git a/doc/mit.html b/doc/mit.html
new file mode 100644 (file)
index 0000000..e30e02e
--- /dev/null
@@ -0,0 +1,26 @@
+<html>
+<title>MIT License</title>
+<body>
+<pre>
+Copyright (c) 2014 Konrad Rosenbaum &lt;konrad@silmor.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+</pre>
+</body>
+</html>
\ No newline at end of file
diff --git a/hidapi b/hidapi
new file mode 160000 (submodule)
index 0000000..d17db57
--- /dev/null
+++ b/hidapi
@@ -0,0 +1 @@
+Subproject commit d17db57b9d4354752e0af42f5f33007a42ef2906
diff --git a/libfido/libfido.h b/libfido/libfido.h
new file mode 100644 (file)
index 0000000..391b845
--- /dev/null
@@ -0,0 +1,128 @@
+/*
+LibFIDO header file
+
+Copyright (c) 2014 Konrad Rosenbaum <konrad@silmor.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
+#ifndef LIBFIDO_H_
+#define LIBFIDO_H_
+
+
+/// successful request
+#define FIDO_SUCCESS    0
+/// there was no connection or the connection was lost, call libfido_init()
+#define FIDO_NOCONN     -1
+/// there was an I/O error, unable to send/receive data
+#define FIDO_IOERR      -2
+/// the request was rejected by the daemon
+#define FIDO_REJECTED   -3
+
+/// Initialize the library: establishes a connection to the FIDO daemon.
+/// \returns 0 on success
+int libfido_init();
+
+/// Close the connection to the daemon, free all resources.
+void libfido_done();
+
+enum libfido_client_request_type
+{
+        ///checks that the token is still plugged in
+        libfido_TokenPresent=1,
+        ///actually sends a ping packet to the token and veries it still reacts
+        libfido_PingToken=2,
+        ///enrolls an application with the token, generates a new key
+        libfido_EnrollToken=10,
+        ///verify that a key is present on one of the attached tokens, does not verify user presence
+        libfido_CheckKeyExists=20,
+        ///verifies that a key is present and valid as well as that the user is present
+        libfido_VerifyKeyAndPresence=21,
+};
+
+enum libfido_result_type
+{
+        ///the verification failed completely
+        libfido_Failed=0,
+        ///the key was verified as valid, but no user presence has been checked or the user was not present
+        libfido_VerifiedAbsent=1,
+        ///the key was verified as valid and the user was present
+        libfido_VerifiedPresent=2
+};
+
+struct libfido_client_request
+{
+        //request data
+        libfido_client_request_type type;
+        
+        //generic data
+        unsigned char keyhandle[128],nonce[8],appid[32],challenge[32];
+        unsigned char token_uuid[16];
+        
+        //response data
+        libfido_result_type result;
+};
+
+void libfido_init_client_request(struct libfido_client_request*request,libfido_request_type type);
+void libfido_free_client_request(struct libfido_client_request*request);
+
+void libfido_client_request_set_appid(struct libfido_client_request*request,const char*appid);
+
+int libfido_exec_client_request(struct libfido_client_request*request);
+
+
+struct libfido_token
+{
+        unsigned char token_uuid[16];
+        /** Serial Number */
+        char *serial_number;
+        /** Manufacturer String */
+        char *manufacturer_string;
+        /** Product string */
+        char *product_string;
+};
+
+void libfido_enumerate_tokens(struct libfido_token**tokens,int*numtokens);
+void libfido_free_tokens(struct libfido_token*tokens);
+
+
+enum libfido_server_request_type
+{
+        ///enrolls a key at the server side
+        libfido_EnrollKey,
+        ///creates random data as a challenge parameter
+        libfido_CreateChallenge,
+        ///authenticates the response received from a client
+        libfido_Authenticate
+};
+
+struct libfido_server_request
+{
+        libfido_server_request_type type;
+        
+        ///the server domain/context in which the key is used
+        char domain[1024];
+};
+
+void libfido_init_server_request(struct libfido_server_request*request,libfido_server_request_type type,const char*domain);
+void libfido_free_server_request(struct libfido_server_request*request);
+
+int libfido_exec_server_request(struct libfido_server_request*request);
+
+#endif
diff --git a/testapp/Makefile b/testapp/Makefile
new file mode 100644 (file)
index 0000000..3e20259
--- /dev/null
@@ -0,0 +1,20 @@
+
+SOURCES = $(shell ls *.c)
+OBJECTS = $(SOURCES:.c=.o)
+
+USBCFLAGS = $(shell pkg-config libusb-1.0 --cflags)
+USBLIBS = $(shell pkg-config libusb-1.0 --libs)
+
+CFLAGS = -g -Wall $(USBCFLAGS)
+LDFLAGS = $(USBLIBS)
+CC = gcc
+
+testapp: $(OBJECTS)
+       $(CC) -o $@ $^ $(LDFLAGS)
+
+%.o: %.c
+       $(CC) $(CFLAGS) -c $<
+
+.PHONY: clean
+clean:
+       -rm -rf testapp *.o
diff --git a/testapp/fidodevice.c b/testapp/fidodevice.c
new file mode 100644 (file)
index 0000000..c46cf75
--- /dev/null
@@ -0,0 +1,151 @@
+#include <libusb.h>
+#include <stdlib.h>
+#include <fcntl.h>
+#include <string.h>
+#include <stdio.h>
+#include <unistd.h>
+
+#include "fidodevice.h"
+
+#include "hidapi_report.h"
+
+#include "u2f.h"
+#include "u2f_hid.h"
+
+struct fido_device_s*fido_devicelist=NULL;
+
+int fido_numdevices()
+{
+        int num=0;
+        struct fido_device_s *dev;
+        for(dev=fido_devicelist;dev!=NULL;dev=dev->next)num++;
+        return num;
+}
+
+void fido_freedevice()
+{
+        struct fido_device_s*dev,*tmp;
+        for(dev=fido_devicelist;dev!=NULL;dev=tmp){
+                tmp=dev->next;
+                libusb_unref_device(dev->device);
+                free(dev);
+        }
+        fido_devicelist=NULL;
+}
+
+libusb_device_handle*fido_open(struct fido_device_s*dev)
+{
+        libusb_device_handle*hdl;
+        int r;
+        if((r=libusb_open(dev->device,&hdl))!=0){
+                fprintf(stderr,"Unable to open Device %04x:%04x - %s (%i)\n",dev->idVendor,dev->idProduct,libusb_strerror(r),r);
+                return NULL;
+        }
+        libusb_set_auto_detach_kernel_driver(hdl,1);
+        if((r=libusb_claim_interface(hdl,dev->interfaceidx))!=0){
+                fprintf(stderr,"Unable to claim Device %04x:%04x Interface %i - %s (%i)\n",dev->idVendor,dev->idProduct,dev->interface,libusb_strerror(r),r);
+                libusb_close(hdl);
+                return NULL;
+        }
+        if((r=libusb_set_interface_alt_setting(hdl,dev->interfaceidx,dev->altsettingidx))!=0){
+                fprintf(stderr,"Unable to set alt-setting correctly %04x:%04x Interface %i AltSetting %i - %s (%i)\n", dev->idVendor, dev->idProduct, dev->interface, dev->altsetting, libusb_strerror(r),r);
+                libusb_release_interface(hdl,dev->interfaceidx);
+                libusb_close(hdl);
+                return NULL;
+        }
+        return hdl;
+}
+
+void fido_close(libusb_device_handle*hdl,struct fido_device_s*dev)
+{
+        libusb_release_interface(hdl,dev->interfaceidx);
+        libusb_close(hdl);
+}
+
+static int fido_getrandom(unsigned char*data,int length)
+{
+        if(data==NULL)return 0;
+        if(length<=0)return 0;
+        int fd=open("/dev/random",O_RDONLY);
+        if(fd<0)return 0;
+        int rd=read(fd,data,length);
+        close(fd);
+        if(rd<length)return 0;
+        else return length;
+}
+
+static char*bytes2hex(unsigned char*data,int len)
+{
+        static char buf[1024*2+1];
+        static const char hex[]="0123456789ABCDEF";
+        memset(buf,0,sizeof(buf));
+        int i;
+        for(i=0;i<len;i++){
+                buf[i*2]=hex[data[i]>>4];
+                buf[i*2+1]=hex[data[i]&0xf];
+        }
+        return buf;
+}
+
+static void fido_info_one(struct fido_device_s*dev)
+{
+        //open device
+        libusb_device_handle*hdl=fido_open(dev);
+        if(hdl==NULL)
+                return;
+        //send command
+        unsigned char data[1024];
+        memset(data,0,sizeof(data));
+        data[0]=FIDO_USAGE_DATA_OUT;
+        data[1]=U2FHID_INIT;
+        data[2]=8;
+        fido_getrandom(data+3,8);
+        int ret=hid_write(hdl,dev->interfaceidx,dev->endpointout,data,11);
+        if(ret>=0){
+                memset(data,0,sizeof(data));
+                data[0]=FIDO_USAGE_DATA_IN;
+                ret=hid_read(hdl,dev->interfaceidx,dev->endpointin,data,sizeof(data));
+                if(ret>=0){
+                        printf("  Report Length: %i\n  Report Type: %i (%s)\n",ret,data[0],data[0]==FIDO_USAGE_DATA_IN?"FIDO IN":"?");
+                        printf("  Nonce: %s\n",bytes2hex(data+2,8));
+                        printf("  Channel: %s\n",bytes2hex(data+10,4));
+                        printf("  Protocol Version: %i\n  Major Device Version: %i\n  Minor Device Version: %i\n  Build Device Version: %i\n  Capabilities: %02x\n",data[14],data[15],data[16],data[17],data[18]);
+                }else
+                        fprintf(stderr,"Failed to receive response to INIT request: %s\n",libusb_strerror(ret));
+        }else
+                fprintf(stderr,"Unable to transmit INIT request: %s\n",libusb_strerror(ret));
+        //free device
+        fido_close(hdl,dev);
+}
+
+void fido_info()
+{
+        struct fido_device_s*dev;
+        for(dev=fido_devicelist;dev!=NULL;dev=dev->next){
+                printf("Device %04x:%04x\n",dev->idVendor,dev->idProduct);
+                fido_info_one(dev);
+        }
+}
+
+
+int fido_send(struct fido_device_s*dev,unsigned int channel,unsigned char cmd,unsigned char *data,int length)
+{
+        if(cmd<0x80)return 0;//not a valid command
+        if(dev->packetsize<7 || dev->packetsize>1024)return -100; //ooops!
+        if(length<0 || length > (dev->packetsize-7 + 128*(dev->packetsize-5)))return -1;//too much data
+        unsigned char frame[1024];
+        //construct command frame
+        frame[0]=FIDO_USAGE_DATA_OUT;
+        frame[1]=cmd;
+        frame[2]=channel>>24;
+        frame[3]=(channel>>16)&0xff;
+        frame[4]=(channel>>8)&0xff;
+        frame[5]=channel&0xff;
+        frame[6]=(length>>8)&0xff;
+        frame[7]=length&0xff;
+        int plen=length;
+        if(plen>(dev->packetsize-7))plen=dev->packetsize-7;
+        memcpy(frame+8,data,plen);
+        if(hid_write()
+        //construct remaining frames
+}
diff --git a/testapp/fidodevice.h b/testapp/fidodevice.h
new file mode 100644 (file)
index 0000000..d1b0da2
--- /dev/null
@@ -0,0 +1,27 @@
+
+struct libusb_device;
+
+struct fido_device_s {
+        struct libusb_device*device;
+        unsigned short idVendor,idProduct;
+        unsigned char interface,interfaceidx,altsetting,altsettingidx,config;
+        unsigned char endpointin,endpointout;
+        int packetsize;
+        struct fido_device_s*next;
+};
+
+extern struct fido_device_s*fido_devicelist;
+
+///returns the number of detected devices
+int fido_numdevices();
+///frees all devices
+void fido_freedevice();
+
+///prints info about all devices
+void fido_info();
+
+///send a message to the fido device, returns 1 on success, <=0 on failure
+int fido_send(struct fido_device_s*dev,unsigned int channel,unsigned char cmd,unsigned char *data,int length);
+
+//default protocol timeout in ms
+#define FIDO_TIMEOUT 30000
diff --git a/testapp/hidapi_report.c b/testapp/hidapi_report.c
new file mode 100644 (file)
index 0000000..47d64a7
--- /dev/null
@@ -0,0 +1,155 @@
+/*******************************************************
+ HIDAPI - Multi-Platform library for
+ communication with HID devices.
+
+ Alan Ott
+ Signal 11 Software
+
+ 8/22/2009
+ Linux Version - 6/2/2010
+ Libusb Version - 8/13/2010
+ FreeBSD Version - 11/1/2011
+
+ Copyright 2009, All Rights Reserved.
+
+ At the discretion of the user of this library,
+ this software may be licensed under the terms of the
+ GNU General Public License v3, a BSD-Style license, or the
+ original HIDAPI license as outlined in the LICENSE.txt,
+ LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
+ files located at the root of the source distribution.
+ These files may also be found in the public source
+ code repository located at:
+        http://github.com/signal11/hidapi .
+********************************************************/
+
+//Slightly modified by Konrad Rosenbaum, 2014
+
+#include <libusb.h>
+#include <pthread.h>
+#include <time.h>
+#include <stdlib.h>
+
+#include "fidodevice.h"
+
+int hid_send_feature_report(libusb_device_handle *dev, unsigned char interface, const unsigned char *data, size_t length)
+{
+        int res = -1;
+        int skipped_report_id = 0;
+        int report_number = data[0];
+
+        if (report_number == 0x0) {
+                data++;
+                length--;
+                skipped_report_id = 1;
+        }
+
+        res = libusb_control_transfer(dev,
+                LIBUSB_REQUEST_TYPE_CLASS|LIBUSB_RECIPIENT_INTERFACE|LIBUSB_ENDPOINT_OUT,
+                0x09/*HID set_report*/,
+                (3/*HID feature*/ << 8) | report_number,
+                interface,
+                (unsigned char *)data, length,
+                FIDO_TIMEOUT/*timeout millis*/);
+
+        if (res < 0)
+                return res;
+
+        /* Account for the report ID */
+        if (skipped_report_id)
+                length++;
+
+        return length;
+}
+
+int hid_get_feature_report(libusb_device_handle *dev, unsigned char interface, unsigned char *data, size_t length)
+{
+        int res = -1;
+        int skipped_report_id = 0;
+        int report_number = data[0];
+
+        if (report_number == 0x0) {
+                /* Offset the return buffer by 1, so that the report ID
+                   will remain in byte 0. */
+                data++;
+                length--;
+                skipped_report_id = 1;
+        }
+        res = libusb_control_transfer(dev,
+                LIBUSB_REQUEST_TYPE_CLASS|LIBUSB_RECIPIENT_INTERFACE|LIBUSB_ENDPOINT_IN,
+                0x01/*HID get_report*/,
+                (3/*HID feature*/ << 8) | report_number,
+                interface,
+                (unsigned char *)data, length,
+                FIDO_TIMEOUT/*timeout millis*/);
+
+        if (res < 0)
+                return res;
+
+        if (skipped_report_id)
+                res++;
+
+        return res;
+}
+
+
+
+int hid_write(libusb_device_handle *dev, unsigned char interface, unsigned char endpoint, const unsigned char *data, size_t length)
+{
+        int res;
+        int report_number = data[0];
+        int skipped_report_id = 0;
+
+        if (report_number == 0x0) {
+                data++;
+                length--;
+                skipped_report_id = 1;
+        }
+
+
+        if (endpoint <= 0) {
+                /* No interrput out endpoint. Use the Control Endpoint */
+                res = libusb_control_transfer(dev,
+                        LIBUSB_REQUEST_TYPE_CLASS|LIBUSB_RECIPIENT_INTERFACE|LIBUSB_ENDPOINT_OUT,
+                        0x09/*HID Set_Report*/,
+                        (2/*HID output*/ << 8) | report_number,
+                        interface,
+                        (unsigned char *)data, length,
+                        FIDO_TIMEOUT/*timeout millis*/);
+
+                if (res < 0)
+                        return res;
+
+                if (skipped_report_id)
+                        length++;
+
+                return length;
+        }
+        else {
+                /* Use the interrupt out endpoint */
+                int actual_length;
+                res = libusb_interrupt_transfer(dev,
+                        endpoint,
+                        (unsigned char*)data,
+                        length,
+                        &actual_length, FIDO_TIMEOUT);
+
+                if (res < 0)
+                        return res;
+
+                if (skipped_report_id)
+                        actual_length++;
+
+                return actual_length;
+        }
+}
+
+
+//actually completely re-implemented synchronously
+int hid_read(libusb_device_handle *dev, unsigned char interface, unsigned char endpoint, unsigned char *data, size_t length)
+{
+        int reallength;
+        int res= libusb_interrupt_transfer(dev,endpoint,data,length,&reallength,FIDO_TIMEOUT);
+        if(res==0)return reallength;
+        else return res;
+}
diff --git a/testapp/hidapi_report.h b/testapp/hidapi_report.h
new file mode 100644 (file)
index 0000000..84c632e
--- /dev/null
@@ -0,0 +1,8 @@
+#include <stdlib.h>
+
+struct libusb_device_handle;
+
+int hid_send_feature_report(libusb_device_handle *dev, unsigned char interface, const unsigned char *data, size_t length);
+int hid_get_feature_report(libusb_device_handle *dev, unsigned char interface, unsigned char *data, size_t length);
+int hid_write(libusb_device_handle *dev, unsigned char interface, unsigned char endpoint, const unsigned char *data, size_t length);
+int hid_read(libusb_device_handle *dev, unsigned char interface, unsigned char endpoint, unsigned char *data, size_t length);
diff --git a/testapp/hidapi_usage.c b/testapp/hidapi_usage.c
new file mode 100644 (file)
index 0000000..c566391
--- /dev/null
@@ -0,0 +1,125 @@
+/********************************************************************
+ * These functions were copied from the LibUSB based implementation
+ * of HIDAPI:
+ *
+ Alan Ott
+ Signal 11 Software
+
+ 8/22/2009
+ Linux Version - 6/2/2010
+ Libusb Version - 8/13/2010
+ FreeBSD Version - 11/1/2011
+
+ Copyright 2009, All Rights Reserved.
+
+ At the discretion of the user of this library,
+ this software may be licensed under the terms of the
+ GNU General Public License v3, a BSD-Style license, or the
+ original HIDAPI license as outlined in the LICENSE.txt,
+ LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
+ files located at the root of the source distribution.
+ These files may also be found in the public source
+ code repository located at:
+        http://github.com/signal11/hidapi .
+ ********************************************************************/
+
+#include "hidapi_usage.h"
+
+/* Get bytes from a HID Report Descriptor.
+   Only call with a num_bytes of 0, 1, 2, or 4. */
+static uint32_t get_bytes(uint8_t *rpt, size_t len, size_t num_bytes, size_t cur)
+{
+        /* Return if there aren't enough bytes. */
+        if (cur + num_bytes >= len)
+                return 0;
+
+        if (num_bytes == 0)
+                return 0;
+        else if (num_bytes == 1) {
+                return rpt[cur+1];
+        }
+        else if (num_bytes == 2) {
+                return (rpt[cur+2] * 256 + rpt[cur+1]);
+        }
+        else if (num_bytes == 4) {
+                return (rpt[cur+4] * 0x01000000 +
+                        rpt[cur+3] * 0x00010000 +
+                        rpt[cur+2] * 0x00000100 +
+                        rpt[cur+1] * 0x00000001);
+        }
+        else
+                return 0;
+}
+
+/* Retrieves the device's Usage Page and Usage from the report
+   descriptor. The algorithm is simple, as it just returns the first
+   Usage and Usage Page that it finds in the descriptor.
+   The return value is 0 on success and -1 on failure. */
+int hidapi_usage_get_usage(uint8_t* report_descriptor, size_t size, short unsigned int* usage_page, short unsigned int* usage)
+{
+        unsigned int i = 0;
+        int size_code;
+        int data_len, key_size;
+        int usage_found = 0, usage_page_found = 0;
+
+        while (i < size) {
+                int key = report_descriptor[i];
+                int key_cmd = key & 0xfc;
+
+                //printf("key: %02hhx\n", key);
+
+                if ((key & 0xf0) == 0xf0) {
+                        /* This is a Long Item. The next byte contains the
+                           length of the data section (value) for this key.
+                           See the HID specification, version 1.11, section
+                           6.2.2.3, titled "Long Items." */
+                        if (i+1 < size)
+                                data_len = report_descriptor[i+1];
+                        else
+                                data_len = 0; /* malformed report */
+                        key_size = 3;
+                }
+                else {
+                        /* This is a Short Item. The bottom two bits of the
+                           key contain the size code for the data section
+                           (value) for this key.  Refer to the HID
+                           specification, version 1.11, section 6.2.2.2,
+                           titled "Short Items." */
+                        size_code = key & 0x3;
+                        switch (size_code) {
+                        case 0:
+                        case 1:
+                        case 2:
+                                data_len = size_code;
+                                break;
+                        case 3:
+                                data_len = 4;
+                                break;
+                        default:
+                                /* Can't ever happen since size_code is & 0x3 */
+                                data_len = 0;
+                                break;
+                        };
+                        key_size = 1;
+                }
+
+                if (key_cmd == 0x4) {
+                        *usage_page  = get_bytes(report_descriptor, size, data_len, i);
+                        usage_page_found = 1;
+                        //printf("Usage Page: %x\n", (uint32_t)*usage_page);
+                }
+                if (key_cmd == 0x8) {
+                        *usage = get_bytes(report_descriptor, size, data_len, i);
+                        usage_found = 1;
+                        //printf("Usage: %x\n", (uint32_t)*usage);
+                }
+
+                if (usage_page_found && usage_found)
+                        return 0; /* success */
+
+                /* Skip over this key and it's associated data */
+                i += data_len + key_size;
+        }
+
+        return -1; /* failure */
+}
diff --git a/testapp/hidapi_usage.h b/testapp/hidapi_usage.h
new file mode 100644 (file)
index 0000000..1e881cb
--- /dev/null
@@ -0,0 +1,5 @@
+#include <stdint.h>
+#include <stddef.h>
+
+int hidapi_usage_get_usage(uint8_t *report_descriptor, size_t size,
+                     unsigned short *usage_page, unsigned short *usage);
diff --git a/testapp/main.c b/testapp/main.c
new file mode 100644 (file)
index 0000000..1879573
--- /dev/null
@@ -0,0 +1,35 @@
+#include <libusb.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "fidodevice.h"
+#include "scanfordev.h"
+
+static void printhelp(char*app)
+{
+        fprintf(stderr,
+                "Usage: %s <command> <params...>\n\n"
+                "  help\n\tshow help text\n\n"
+                "  info\n\tquery information about the token\n\n"
+                "  register appid [challenge]\n\tregister the key for the given appid, if no challenge is\n\tgiven, one is generated.\n\n"
+                "  auth keyid [challenge]\n\tauthenticates the key, if no challenge is given, one is generated\n\n",
+                app);
+}
+
+int main(int ac,char**av)
+{
+        if(ac<2 || strcmp(av[1],"help")==0 || strcmp(av[1],"--help")==0){
+                printhelp(av[0]);
+                return 0;
+        }
+        libusb_init(NULL);
+        scanfordevices();
+        if(strcmp(av[1],"info")==0){
+                fido_info();
+                return 0;
+        }else{
+                fprintf(stderr,"Unknown sub-command %s.\n",av[1]);
+                printhelp(av[0]);
+                return 1;
+        }
+}
diff --git a/testapp/scanfordev.c b/testapp/scanfordev.c
new file mode 100644 (file)
index 0000000..85b6fe6
--- /dev/null
@@ -0,0 +1,135 @@
+#include <libusb.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "hidapi_usage.h"
+#include "fidodevice.h"
+
+void scaninterface(libusb_device*dev,int iface,int altset,struct libusb_config_descriptor *config,struct libusb_device_descriptor*desc)
+{
+        unsigned char buf[64];
+        int len,i,j;
+        unsigned short usagepage,usage;
+        //sequence for opening and claiming the interface
+        libusb_device_handle*hdl;
+        if(libusb_open(dev,&hdl)!=0){
+                fprintf(stderr,"  Unable to open Device.\n");
+                return;
+        }
+        libusb_set_auto_detach_kernel_driver(hdl,1);
+        if(libusb_claim_interface(hdl,iface)!=0){
+                fprintf(stderr,"  Unable to claim Device.\n");
+                libusb_close(hdl);
+                return;
+        }
+        if(libusb_set_interface_alt_setting(hdl,iface,altset)!=0){
+                fprintf(stderr,"  Unable to set alt-setting correctly.\n");
+                libusb_release_interface(hdl,iface);
+                libusb_close(hdl);
+                return;
+        }
+        //get descriptor
+        if((len=libusb_get_descriptor(hdl,LIBUSB_DT_HID,0,buf,sizeof(buf)))<2){
+                fprintf(stderr,"  Unable to retrieve HID descriptor.\n");
+                libusb_release_interface(hdl,iface);
+                libusb_close(hdl);
+                return;
+        }
+        printf("  Descriptor");
+        for(i=0;i<len;i++)printf(" %02x",buf[i]);
+        printf(".\n");
+        len = libusb_control_transfer(hdl, LIBUSB_ENDPOINT_IN|LIBUSB_RECIPIENT_INTERFACE, LIBUSB_REQUEST_GET_DESCRIPTOR, (LIBUSB_DT_REPORT << 8)|iface, 0, buf, sizeof(buf), 5000);
+        printf("  Descriptor2");
+        for(i=0;i<len;i++)printf(" %02x",buf[i]);
+        printf(".\n");
+        if(hidapi_usage_get_usage(buf,len,&usagepage,&usage)==0){
+                printf("  Usage Page: 0x%04x; Usage: 0x%04x; ",usagepage,usage);
+                if(usagepage==0xf1d0 && usage==1){
+                        printf("THIS IS A MATCH!\n");
+                        struct fido_device_s*devd=malloc(sizeof(struct fido_device_s));
+                        memset(devd,0,sizeof(struct fido_device_s));
+                        devd->altsetting=config->interface[iface].altsetting[altset].bAlternateSetting;
+                        devd->altsettingidx=altset;
+                        devd->config=config->bConfigurationValue;
+                        devd->interface=config->interface[iface].altsetting[altset].iInterface;
+                        devd->interfaceidx=iface;
+                        devd->idProduct=desc->idProduct;
+                        devd->idVendor=desc->idVendor;
+                        devd->packetsize=desc->bMaxPacketSize0;
+                        devd->device=libusb_ref_device(dev);
+                        for(j=0;j<config->interface[iface].altsetting[altset].bNumEndpoints;j++){
+                                unsigned char ep=config->interface[iface].altsetting[altset].endpoint[j].bEndpointAddress;
+                                int ps=config->interface[iface].altsetting[altset].endpoint[j].wMaxPacketSize;
+                                if(ep&LIBUSB_ENDPOINT_IN)
+                                        devd->endpointin=ep;
+                                else
+                                        devd->endpointout=ep;
+                                if(ps<devd->packetsize)devd->packetsize=ps;
+                        }
+                        devd->next=fido_devicelist;
+                        fido_devicelist=devd;
+                }else printf("Sorry, no match.\n");
+        }
+        libusb_release_interface(hdl,iface);
+        libusb_close(hdl);
+}
+
+void scandevice(libusb_device*dev)
+{
+        struct libusb_device_descriptor dd;
+        struct libusb_config_descriptor *config;
+        int i,j,k;
+        if(libusb_get_device_descriptor(dev,&dd)!=0){
+                fprintf(stderr,"Unable to scan one device.\n");
+                return;
+        }
+        printf("Device ID %04x:%04x type %i subtype %i\n",dd.idVendor,dd.idProduct,dd.bDeviceClass,dd.bDeviceSubClass);
+        if(dd.bDeviceClass!=LIBUSB_CLASS_PER_INTERFACE && dd.bDeviceClass!=LIBUSB_CLASS_HID)return;//not direct HID or per-Iface
+        if(dd.bDeviceClass==LIBUSB_CLASS_HID && dd.bDeviceSubClass!=0)return;//direct HID, but not "unspecific"
+        printf("Device Type ok, ID %04x:%04x\n",dd.idVendor,dd.idProduct);
+        //scan interfaces
+        if(libusb_get_active_config_descriptor(dev,&config)!=0){
+                fprintf(stderr,"Unable to get active Configuration of Device %04x:%04x\n",dd.idVendor,dd.idProduct);
+                return;
+        }
+        for(i=0;i<config->bNumInterfaces;i++){
+                for(j=0;j<config->interface[i].num_altsetting;j++){
+                        printf("  Scanning Config %i Iface %i Altsetting %i... ",config->bConfigurationValue, config->interface[i].altsetting[j].bInterfaceNumber, config->interface[i].altsetting[j].bAlternateSetting);
+                        if(config->interface[i].altsetting[j].bInterfaceClass==LIBUSB_CLASS_HID && config->interface[i].altsetting[j].bInterfaceSubClass==0){
+                                printf("potential match!\n");
+                                printf("  desctype %i exlen %i\n",
+                                        config->interface[i].altsetting[j].bDescriptorType,
+                                        config->interface[i].altsetting[j].extra_length
+                                );
+                                for(k=0;k<config->interface[i].altsetting[j].bNumEndpoints;k++)
+                                        printf("  endpoint %02x packet size %i\n",
+                                               config->interface[i].altsetting[j].endpoint[k].bEndpointAddress,
+                                               config->interface[i].altsetting[j].endpoint[k].wMaxPacketSize);
+                                printf("  extra");
+                                for(k=0;k<config->interface[i].altsetting[j].extra_length;k++)
+                                        printf(" %02x",config->interface[i].altsetting[j].extra[k]);
+                                printf(".\n");
+                                scaninterface(dev,i,j,config,&dd);
+                        }else
+                                printf("no match.\n");
+                }
+        }
+        libusb_free_config_descriptor(config);
+}
+
+void scanfordevices()
+{
+        struct libusb_device**devlist;
+        ssize_t numdevs;
+        int i;
+        numdevs=libusb_get_device_list(NULL,&devlist);
+        if(numdevs<=0){
+                fprintf(stderr,"No USB devices found.\n");
+                return;
+        }
+        for(i=0;i<numdevs;i++){
+                scandevice(devlist[i]);
+        }
+        libusb_free_device_list(devlist,1);
+}
diff --git a/testapp/scanfordev.h b/testapp/scanfordev.h
new file mode 100644 (file)
index 0000000..413ea52
--- /dev/null
@@ -0,0 +1,2 @@
+void scanfordevices();
+
diff --git a/testapp/u2f.h b/testapp/u2f.h
new file mode 100644 (file)
index 0000000..6d447c2
--- /dev/null
@@ -0,0 +1,103 @@
+// Common U2F raw message format header - Review Draft
+// 2014-10-08
+// Editor: Jakob Ehrensvard, Yubico, jakob@yubico.com
+
+#ifndef __U2F_H_INCLUDED__
+#define __U2F_H_INCLUDED__
+
+#ifdef _MSC_VER // Windows
+typedef unsigned char uint8_t;
+typedef unsigned short uint16_t;
+typedef unsigned int uint32_t;
+typedef unsigned long int uint64_t;
+#else
+#include <stdint.h>
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// General constants
+#define U2F_EC_KEY_SIZE 32 // EC key size in bytes
+#define U2F_EC_POINT_SIZE ((U2F_EC_KEY_SIZE * 2) + 1) // Size of EC point
+#define U2F_MAX_KH_SIZE 128 // Max size of key handle
+#define U2F_MAX_ATT_CERT_SIZE 2048 // Max size of attestation certificate
+#define U2F_MAX_EC_SIG_SIZE 72 // Max size of DER coded EC signature
+#define U2F_CTR_SIZE 4 // Size of counter field
+#define U2F_APPID_SIZE 32 // Size of application id
+#define U2F_CHAL_SIZE 32 // Size of challenge
+
+#define ENC_SIZE(x) ((x + 7)& 0xfff8)
+
+// EC (uncompressed) point
+
+#define U2F_POINT_UNCOMPRESSED 0x04 // Uncompressed point format
+
+typedef struct {
+        uint8_t pointFormat; // Point type
+        uint8_t x[U2F_EC_KEY_SIZE]; // X-value
+        uint8_t y[U2F_EC_KEY_SIZE]; // Y-value
+} U2F_EC_POINT;
+
+// U2F native commands
+#define U2F_REGISTER 0x01 // Registration command
+#define U2F_AUTHENTICATE 0x02 // Authenticate/sign command
+#define U2F_VERSION 0x03 // Read version string command
+
+#define U2F_VENDOR_FIRST 0xc0 // First vendor defined command
+#define U2F_VENDOR_LAST 0xff // Last vendor defined command
+
+// U2F_CMD_REGISTER command defines
+
+#define U2F_REGISTER_ID 0x05 // Version 2 registration identifier
+#define U2F_REGISTER_HASH_ID 0x00 // Version 2 hash identintifier
+
+typedef struct {
+        uint8_t chal[U2F_CHAL_SIZE]; // Challenge
+        uint8_t appId[U2F_APPID_SIZE]; // Application id
+} U2F_REGISTER_REQ;
+
+typedef struct {
+        uint8_t registerId; // Registration identifier (U2F_REGISTER_ID_V2)
+        U2F_EC_POINT pubKey; // Generated public key
+        uint8_t keyHandleLen; // Length of key handle
+        uint8_t keyHandleCertSig[
+                U2F_MAX_KH_SIZE + // Key handle
+                U2F_MAX_ATT_CERT_SIZE + // Attestation certificate
+                U2F_MAX_EC_SIG_SIZE]; // Registration signature
+} U2F_REGISTER_RESP;
+
+// U2F_CMD_AUTHENTICATE command defines
+
+// Authentication control byte
+
+#define U2F_AUTH_ENFORCE 0x03 // Enforce user presence and sign
+#define U2F_AUTH_CHECK_ONLY 0x07 // Check only
+#define U2F_AUTH_FLAG_TUP 0x01 // Test of user presence set
+
+typedef struct {
+        uint8_t chal[U2F_CHAL_SIZE]; // Challenge
+        uint8_t appId[U2F_APPID_SIZE]; // Application id
+        uint8_t keyHandleLen; // Length of key handle
+        uint8_t keyHandle[U2F_MAX_KH_SIZE]; // Key handle
+} U2F_AUTHENTICATE_REQ;
+
+typedef struct {
+        uint8_t flags; // U2F_AUTH_FLAG_ values
+        uint8_t ctr[U2F_CTR_SIZE]; // Counter field (big-endian)
+        uint8_t sig[U2F_MAX_EC_SIG_SIZE]; // Signature
+} U2F_AUTHENTICATE_RESP;
+
+// Command status responses
+#define U2F_SW_NO_ERROR 0x9000 // SW_NO_ERROR
+#define U2F_SW_WRONG_DATA 0x6984 // SW_WRONG_DATA
+#define U2F_SW_CONDITIONS_NOT_SATISFIED 0x6985 // SW_CONDITIONS_NOT_SATISFIED
+#define U2F_SW_INS_NOT_SUPPORTED 0x6d00 // SW_INS_NOT_SUPPORTED
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __U2F_H_INCLUDED__
diff --git a/testapp/u2f_hid.h b/testapp/u2f_hid.h
new file mode 100644 (file)
index 0000000..ed7b63a
--- /dev/null
@@ -0,0 +1,129 @@
+// Common U2F HID transport header - Review Draft
+// 2014-10-08
+// Editor: Jakob Ehrensvard, Yubico, jakob@yubico.com
+
+#ifndef __U2FHID_H_INCLUDED__
+#define __U2FHID_H_INCLUDED__
+
+#ifdef _MSC_VER // Windows
+typedef unsigned char uint8_t;
+typedef unsigned short uint16_t;
+typedef unsigned int uint32_t;
+typedef unsigned long int uint64_t;
+#else
+#include <stdint.h>
+#endif
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Size of HID reports
+
+#define HID_RPT_SIZE 64 // Default size of raw HID report
+
+// Frame layout - command- and continuation frames
+
+#define CID_BROADCAST 0xffffffff // Broadcast channel id
+
+#define TYPE_MASK 0x80 // Frame type mask
+#define TYPE_INIT 0x80 // Initial frame identifier
+#define TYPE_CONT 0x00 // Continuation frame identifier
+
+typedef struct {
+        uint32_t cid; // Channel identifier
+        union {
+                uint8_t type; // Frame type - b7 defines type
+                struct {
+                        uint8_t cmd; // Command - b7 set
+                        uint8_t bcnth; // Message byte count - high part
+                        uint8_t bcntl; // Message byte count - low part
+                        uint8_t data[HID_RPT_SIZE - 7]; // Data payload
+                } init;
+                struct {
+                        uint8_t seq; // Sequence number - b7 cleared
+                        uint8_t data[HID_RPT_SIZE - 5]; // Data payload
+                }cont;
+        };
+} U2FHID_FRAME;
+
+#define FRAME_TYPE(f) ((f).type & TYPE_MASK)
+#define FRAME_CMD(f)  ((f).init.cmd & ~TYPE_MASK)
+#define MSG_LEN(f)    ((f).init.bcnth*256 + (f).init.bcntl)
+#define FRAME_SEQ(f)  ((f).cont.seq & ~TYPE_MASK)
+
+// HID usage- and usage-page definitions
+
+#define FIDO_USAGE_PAGE     0xf1d0 // FIDO alliance HID usage page
+#define FIDO_USAGE_U2FHID   0x01   // U2FHID usage for top-level collection
+#define FIDO_USAGE_DATA_IN  0x20   // Raw IN data report
+#define FIDO_USAGE_DATA_OUT 0x21   // Raw OUT data report
+
+// General constants
+
+#define U2FHID_IF_VERSION       2 // Current interface implementation version
+#define U2FHID_TRANS_TIMEOUT 3000 // Default message timeout in ms
+
+// U2FHID native commands
+
+#define U2FHID_PING  (TYPE_INIT | 0x01) // Echo data through local processor only
+#define U2FHID_MSG   (TYPE_INIT | 0x03) // Send U2F message frame
+#define U2FHID_LOCK  (TYPE_INIT | 0x04) // Send lock channel command
+#define U2FHID_INIT  (TYPE_INIT | 0x06) // Channel initialization
+#define U2FHID_WINK  (TYPE_INIT | 0x08) // Send device identification wink
+#define U2FHID_SYNC  (TYPE_INIT | 0x3c) // Protocol resync command
+#define U2FHID_ERROR (TYPE_INIT | 0x3f) // Error response
+
+#define U2FHID_VENDOR_FIRST (TYPE_INIT | 0x40) // First vendor defined command
+#define U2FHID_VENDOR_LAST  (TYPE_INIT | 0x7f) // Last vendor defined command
+
+
+// U2FHID_INIT command defines
+
+#define INIT_NONCE_SIZE 8    // Size of channel initialization challenge
+#define CAPFLAG_WINK    0x01 // Device supports WINK command
+
+
+typedef struct {
+        uint8_t nonce[INIT_NONCE_SIZE]; // Client application nonce
+} U2FHID_INIT_REQ;
+
+typedef struct {
+        uint8_t nonce[INIT_NONCE_SIZE]; // Client application nonce
+        uint32_t cid; // Channel identifier
+        uint8_t versionInterface; // Interface version
+        uint8_t versionMajor; // Major version number
+        uint8_t versionMinor; // Minor version number
+        uint8_t versionBuild; // Build version number
+        uint8_t capFlags; // Capabilities flags
+} U2FHID_INIT_RESP;
+
+// U2FHID_SYNC command defines
+
+typedef struct {
+        uint8_t nonce; // Client application nonce
+} U2FHID_SYNC_REQ;
+
+typedef struct {
+        uint8_t nonce; // Client application nonce
+} U2FHID_SYNC_RESP;
+
+// Low-level error codes. Return as negatives.
+
+#define ERR_NONE          0x00 // No error
+#define ERR_INVALID_CMD   0x01 // Invalid command
+#define ERR_INVALID_PAR   0x02 // Invalid parameter
+#define ERR_INVALID_LEN   0x03 // Invalid message length
+#define ERR_INVALID_SEQ   0x04 // Invalid message sequencing
+#define ERR_MSG_TIMEOUT   0x05 // Message has timed out
+#define ERR_CHANNEL_BUSY  0x06 // Channel busy
+#define ERR_LOCK_REQUIRED 0x0a // Command requires channel lock
+#define ERR_SYNC_FAIL     0x0b // SYNC command failed
+#define ERR_OTHER         0x7f // Other unspecified error
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __U2FHID_H_INCLUDED__