diff --git a/LICENSE.TXT b/LICENSE.TXT new file mode 100644 index 0000000..818433e --- /dev/null +++ b/LICENSE.TXT @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..cba50ec --- /dev/null +++ b/Makefile @@ -0,0 +1,58 @@ +############################################### +# Linux +############################################### +LIB_TYPE=so +LIB_FLAGS=-shared +PCSC_HEADERS=-I/usr/include/PCSC +PCSC_LIB=-lpcsclite -Wl,-rpath,. + +############################################### +# MacOS X +############################################### +#LIB_TYPE=dylib +#LIB_FLAGS=-dynamiclib -flat_namespace -undefined suppress +#PCSC_HEADERS=-I/System/Library/Frameworks/PCSC.framework/Headers +#PCSC_LIB=-framework PCSC + +CC = gcc +LD = gcc +CFLAGS = -fPIC -Wall -std=c99 -O4 $(PCSC_HEADERS) +LDFLAGS = -fPIC $(PCSC_LIB) + +OBJS = acr122.o bitutils.o libnfc.o +HEADERS = acr122.h bitutils.h defines.h libnfc.h +LIB = libnfc.$(LIB_TYPE) +EXES = anticol list simulate relay mfread mfwrite + +all: $(LIB) $(EXES) + +acr122.o: acr122.c $(HEADERS) +bitutils.o: bitutils.c $(HEADERS) +libnfc.o: libnfc.c $(HEADERS) + +%.s : %.c + $(CC) -S -dA $(CFLAGS) -o $@ $< + +libnfc.$(LIB_TYPE): $(OBJS) + $(LD) $(LDFLAGS) -o $(LIB) $(LIB_FLAGS) $(OBJS) + +anticol: $(OBJS) + $(LD) $(LDFLAGS) -o anticol anticol.c -L. -lnfc + +list: $(OBJS) + $(LD) $(LDFLAGS) -o list list.c -L. -lnfc + +simulate: $(OBJS) + $(LD) $(LDFLAGS) -o simulate simulate.c -L. -lnfc + +relay: $(OBJS) + $(LD) $(LDFLAGS) -o relay relay.c -L. -lnfc + +mfread: $(OBJS) + $(LD) $(LDFLAGS) -o mfread mfread.c -L. -lnfc + +mfwrite: $(OBJS) + $(LD) $(LDFLAGS) -o mfwrite mfwrite.c -L. -lnfc + +clean: + rm -f $(OBJS) $(LIB) $(EXES) diff --git a/README.TXT b/README.TXT new file mode 100644 index 0000000..22c3e77 --- /dev/null +++ b/README.TXT @@ -0,0 +1,146 @@ +------------------------------------------------------------------------ +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +------------------------------------------------------------------------ +Welcome to the community of libnfc (website: http://www.libnfc.org). + +libnfc version 1.0.0 + +Index: +1. Introduction +2. Hardware +3. Compilation +4. Examples +5. Todo +6. Contact + +------------------------------------------------------------------------ +1. Introduction + +Since the RFID market is spoiled by proprietary hard and software +we want to contribute constructively by distributing a free library +which can be used in RFID/NFC applications. + +------------------------------------------------------------------------ +2. Hardware + +To communicate with NFC targets/tags you need a USB device which is +called a "RFID Reader". The cheapest hardware around that can carries +a fully NFC complied chip is the ACR122 from the company ACS, Advanced +Card Systems Limited (website: http://www.acs.com.hk/acr122.php). +This reader uses the PN532 chipset from NXP Semiconductors. The reader +costs around the €60 and is available in different webshops all over +the world. The NFC reader used in the "tikitag" project is exactly the +same reader as the ACR122 but with a different logo. This reader is +available for only €35,- (website: http://www.tikitag.com). We would +recommend to use one of these readers, since we tested both of them. + +Other NFC readers, like the SCL3710 from SCM Microsystems (website: +http://www.scmmicro.com/scl3710/) are not supported yet. They use the +same chipset, so the instruction set is completely the same. This means +that with little effort these readers could be added to be part of the +NFC library. We would be very pleased if someone is willing to add this +support to libnfc. + +------------------------------------------------------------------------ +3. Compilation + +If you use linux, please make sure you have libpcsc-lite installed. +For Ubuntu this means you have to install the following packages: +$sudo apt-get install pcscd +$sudo apt-get install libpcsclite-dev +When these are installed, just run "make" and you are ready to go. + +MacOSX users have to edit the "Makefile" file in the main directory. +Uncomment the following lines: +#LIB_TYPE=... +#LIB_FLAGS=... +#PCSC_HEADERS=... +#PCSC_LIB=... +Run "make" and you it should work like a charm. + +Windows users can use the binairy files located in the "win32bin" +directory. Or they can open the VS2005 solution which can be found +in the "win32" directory. Compilation should work "out of the box". + +------------------------------------------------------------------------ +4. Examples + +There are 6 example tools coming with this library. They can be used +as a reference during development of your software. All tools try to +demonstrate a different feature. Below there is short description of +the tools and their purpose. + +anticol - Anti-collision demonstration tool for ISO14443A tags using + self constructed REQA/WUPA and SELECT frames. + +list - List passive tags tool for ISO14443A tags using the commands + available in the instruction set of the hardware chip. + +simulate - With this example you can turn your reader into a NFC target. + For testing purposes it simulates a ISO14443A tag with a UID + that consists of 0xDEADBEAF. The frames are delayed because + of the USB communication, so not all readers will recognize + the tag. The "Omnikey 5121" though has no problems with this + small delay. + +relay - This tool allows the user to use 2 readers. One will similate + a ISO14443A tag, while the 2nd reader will stay a reader. + The original tag can be placed on the 2nd reader and the + simulated tag can be placed on top of the original reader. + All communication is relayed now and showed on the screen. + NOTE: relaying frames is time-consuming, not all readers + allow slow responds from the (simulated) tag. Though, one of + the most used RFID readers, the "Omnikey 5121" has no problem + and can perfectly be used for demonstrating this features. + +mfread - With this tool a complete MIFARE card can be readout and stored + in a MIFARE dump file (*.mfd). + +mfwrite - With this tool a complete MIFARE card can be restored from a + a MIFARE dump file (*.mfd) back to the tag. + +A MIFARE dump file (*.mfd) is a plain 4KB image of a mifare tag. This +image should contain the data, keys and access bits on their usual position. +A Dump file is always 4KB, even when a 1KB tag is dumped. From the first +block, the manufacturer data, can be determined if you are dealing with +a 1KB or a 4KB tag. This is stored in the ATQA part of block0 (byte 6/7). +More info can be found in the MIFARE functional specification from NXP. +(Website: http://www.nxp.com/products/identification/mifare/classic) + +------------------------------------------------------------------------ +5. Todo + +Support more communication protocols. Sony Felica, ISO14443B and Innovision +Jewel Topaz tags are supported by the chipset, but they are not used by +this library. It would be very useful if we could add support for these +tags in this library. + +------------------------------------------------------------------------ +6. Contact + +Please visit the website (http://www.libnfc.org) and place your questions +in the community forum there. We are sure a member of the community will +help you out. + +------------------------------------------------------------------------ +Proprietary notes: + +Note: FeliCa is s registered trademark of Sony Corporation. MIFARE is a +trademark of NXP Semiconductors. Jewel Topaz is a trademark of Innovision +Research & Technology. All other trademarks are the property of their +respective owners. diff --git a/acr122.c b/acr122.c new file mode 100644 index 0000000..edd5525 --- /dev/null +++ b/acr122.c @@ -0,0 +1,187 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include +#include +#include "acr122.h" +#include "bitutils.h" + +#define SCARD_OPERATION_SUCCESS 0x61 +#define SCARD_OPERATION_ERROR 0x63 + +#define FIRMWARE_TEXT "ACR122U10" // ACR122U101(ACS), ACR122U102(Tikitag) + +#define ACR122_WRAP_LEN 5 +#define ACR122_COMMAND_LEN 266 + +#define ACR122_RESPONSE_LEN 268 + +#define MAX_READERS 16 + +static SCARDCONTEXT hCtx = null; + +static byte abtTxBuf[ACR122_WRAP_LEN+ACR122_COMMAND_LEN] = { 0xFF, 0x00, 0x00, 0x00 }; +static byte abtRxCmd[5] = { 0xFF,0xC0,0x00,0x00 }; +static byte uiRxCmdLen = sizeof(abtRxCmd); +static byte abtRxBuf[ACR122_RESPONSE_LEN]; +static ulong ulRxBufLen; +static byte abtGetFw[5] = { 0xFF,0x00,0x48,0x00,0x00 }; +static byte abtLed[9] = { 0xFF,0x00,0x40,0x05,0x04,0x00,0x00,0x00,0x00 }; + +dev_id acr122_connect(const ui32 uiDeviceIndex) +{ + SCARDHANDLE hCard = null; + char* pacReaders[MAX_READERS]; + char acList[256+64*MAX_READERS]; + ulong ulListLen = sizeof(acList); + ulong ulActiveProtocol = 0; + ui32 uiPos; + ui32 uiReaderCount; + ui32 uiReader; + ui32 uiReaderIndex; + + // Clear the reader list + memset(acList,0x00,ulListLen); + + // Test if context succeeded + if (SCardEstablishContext(SCARD_SCOPE_USER,null,null,&hCtx) != SCARD_S_SUCCESS) return INVALID_DEVICE_ID; + + // Retrieve the string array of all available pcsc readers + if (SCardListReaders(hCtx,null,acList,(void*)&ulListLen) != SCARD_S_SUCCESS) return INVALID_DEVICE_ID; + + pacReaders[0] = acList; + uiReaderCount = 1; + for (uiPos=0; uiPos ACR122_COMMAND_LEN) return false; + + // Store the length of the command we are going to send + abtTxBuf[4] = uiTxLen; + + #ifdef _LIBNFC_VERBOSE_ + printf("Tx: "); + print_hex(pbtTx,uiTxLen); + #endif + // Prepare and transmit the send buffer + memcpy(abtTxBuf+5,pbtTx,uiTxLen); + ulRxBufLen = sizeof(abtRxBuf); + if (SCardTransmit((SCARDHANDLE)di,SCARD_PCI_T0,abtTxBuf,uiTxLen+5,null,abtRxBuf,(void*)&ulRxBufLen) != SCARD_S_SUCCESS) return false; + + // Make sure we received the byte-count we expected + if (ulRxBufLen != 2) return false; + + // Check if the operation was successful, so an answer is available + if (*abtRxBuf == SCARD_OPERATION_ERROR) return false; + + // Retrieve the response bytes + abtRxCmd[4] = abtRxBuf[1]; + ulRxBufLen = sizeof(abtRxBuf); + if (SCardTransmit((SCARDHANDLE)di,SCARD_PCI_T0,abtRxCmd,uiRxCmdLen,null,abtRxBuf,(void*)&ulRxBufLen) != SCARD_S_SUCCESS) return false; + + // When the answer should be ignored, just return true + if (pbtRx == null || puiRxLen == null) return true; + + // Make sure we have an emulated answer that fits the return buffer + if (ulRxBufLen < 4 || (ulRxBufLen-4) > *puiRxLen) return false; + + // Wipe out the 4 APDU emulation bytes: D5 4B .. .. .. 90 00 + *puiRxLen = ulRxBufLen-4; + memcpy(pbtRx,abtRxBuf+2,*puiRxLen); + #ifdef _LIBNFC_VERBOSE_ + printf("Rx: "); + print_hex(pbtRx,*puiRxLen); + #endif + + // Transmission went successful + return true; +} + +char* acr122_firmware(const dev_id di) +{ + static char abtFw[11]; + ulong ulFwLen = sizeof(abtFw); + memset(abtFw,0x00,ulFwLen); + SCardTransmit((SCARDHANDLE)di,SCARD_PCI_T0,abtGetFw,sizeof(abtGetFw),null,(byte*)abtFw,(void*)&ulFwLen); + return abtFw; +} + +bool acr122_led_red(const dev_id di, bool bOn) +{ + byte abtBuf[2]; + ulong ulBufLen = sizeof(abtBuf); + return (SCardTransmit((SCARDHANDLE)di,SCARD_PCI_T0,abtLed,sizeof(abtLed),null,(byte*)abtBuf,(void*)&ulBufLen) == SCARD_S_SUCCESS); +} + diff --git a/acr122.h b/acr122.h new file mode 100644 index 0000000..d2c7786 --- /dev/null +++ b/acr122.h @@ -0,0 +1,36 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#ifndef _LIBNFC_ACR122_H_ +#define _LIBNFC_ACR122_H_ + +#include "defines.h" +#include "types.h" + +dev_id acr122_connect(const ui32 uiDeviceIndex); +void acr122_disconnect(const dev_id di); +bool acr122_transceive(const dev_id di, const byte* pbtTx, const ui32 uiTxLen, byte* pbtRx, ui32* puiRxLen); +bool acr122_transceive_(const dev_id di, const byte* pbtTx, const ui32 uiTxLen, byte* pbtRx, ui32* puiRxLen); + +char* acr122_firmware(const dev_id di); +bool acr122_led_red(const dev_id di, bool bOn); + +#endif // _LIBNFC_ACR122_H_ + diff --git a/anticol.c b/anticol.c new file mode 100644 index 0000000..876d0a9 --- /dev/null +++ b/anticol.c @@ -0,0 +1,142 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include +#include +#include "libnfc.h" + +static byte abtRecv[MAX_FRAME_LEN]; +static ui32 uiRecvLen; +static byte abtUid[10]; +static ui32 uiUidLen = 4; +static dev_id di; + +// ISO14443A Anti-Collision Commands +byte abtWupa [1] = { 0x52 }; +byte abtSelectAll [2] = { 0x93,0x20 }; +byte abtSelectTag [9] = { 0x93,0x70,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }; +byte abtRats [4] = { 0xe0,0x50,0xbc,0xa5 }; +byte abtHalt [4] = { 0x50,0x00,0x57,0xcd }; + +bool transmit_7bits(const byte btTx) +{ + bool bResult; + printf("R: %02x\n",btTx); + uiRecvLen = MAX_FRAME_LEN; + bResult = nfc_reader_transceive_7bits(di,btTx,abtRecv,&uiRecvLen); + if (bResult) + { + printf("T: "); + print_hex(abtRecv,uiRecvLen); + } + return bResult; +} + +bool transmit_bytes(const byte* pbtTx, const ui32 uiTxLen) +{ + bool bResult; + printf("R: "); + print_hex(pbtTx,uiTxLen); + uiRecvLen = MAX_FRAME_LEN; + bResult = nfc_reader_transceive_bytes(di,pbtTx,uiTxLen,abtRecv,&uiRecvLen); + if (bResult) + { + printf("T: "); + print_hex(abtRecv,uiRecvLen); + } + return bResult; +} + +int main(int argc, const char* argv[]) +{ + // Try to open the NFC reader + di = acr122_connect(0); + + if (di == INVALID_DEVICE_ID) + { + printf("Error connecting NFC reader\n"); + return 1; + } + nfc_reader_init(di); + + // Let the reader only try once to find a tag + nfc_configure_list_passive_infinite(di,false); + + // Drop the field so the tag will be reset + nfc_configure_field(di,false); + + // Configure the communication channel, we use our own CRC + nfc_configure_handle_crc(di,false); + nfc_configure_handle_parity(di,true); + + // Enable the field so the more power consuming tags will respond + nfc_configure_field(di,true); + + printf("\nConnected to NFC reader\n\n"); + + if (!transmit_7bits(*abtWupa)) + { + printf("Error: No tag available\n"); + return 1; + } + // Anti-collision + transmit_bytes(abtSelectAll,2); + + // Save the UID + memcpy(abtUid,abtRecv,4); + memcpy(abtSelectTag+2,abtRecv,5); + append_iso14443a_crc(abtSelectTag,7); + transmit_bytes(abtSelectTag,9); + + if (abtUid[0] == 0x88) + { + abtSelectAll[0] = 0x95; + abtSelectTag[0] = 0x95; + + // Anti-collision + transmit_bytes(abtSelectAll,2); + + // Save the UID + memcpy(abtUid+4,abtRecv,4); + memcpy(abtSelectTag+2,abtRecv,5); + append_iso14443a_crc(abtSelectTag,7); + transmit_bytes(abtSelectTag,9); + uiUidLen = 7; + } + + // Request ATS, this only applies to tags that support ISO 14443A-4 + if (abtRecv[0] & 0x20) + { + transmit_bytes(abtRats,4); + } + + // Done, halt the tag now + transmit_bytes(abtHalt,4); + + printf("\nFound tag with UID: "); + if (uiUidLen == 4) + { + printf("%08x\n",swap_endian32(abtUid)); + } else { + printf("%014llx\n",swap_endian64(abtUid)&0x00ffffffffffffffull); + } + return 0; +} diff --git a/bitutils.c b/bitutils.c new file mode 100644 index 0000000..f7f9458 --- /dev/null +++ b/bitutils.c @@ -0,0 +1,172 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include "bitutils.h" + +const static byte OddParity[256] = { + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, + 1, 0, 0, 1, 0, 1, 1, 0, 0, 1, 1, 0, 1, 0, 0, 1 +}; + +const static byte ByteMirror[256] = { + 0x00, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0, 0x10, 0x90, 0x50, 0xd0, 0x30, + 0xb0, 0x70, 0xf0, 0x08, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8, 0x18, 0x98, + 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8, 0x04, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, + 0xe4, 0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4, 0x0c, 0x8c, 0x4c, 0xcc, + 0x2c, 0xac, 0x6c, 0xec, 0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc, 0x02, + 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2, 0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, + 0x72, 0xf2, 0x0a, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea, 0x1a, 0x9a, 0x5a, + 0xda, 0x3a, 0xba, 0x7a, 0xfa, 0x06, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6, + 0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6, 0x0e, 0x8e, 0x4e, 0xce, 0x2e, + 0xae, 0x6e, 0xee, 0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe, 0x01, 0x81, + 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1, 0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, + 0xf1, 0x09, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9, 0x19, 0x99, 0x59, 0xd9, + 0x39, 0xb9, 0x79, 0xf9, 0x05, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5, 0x15, + 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5, 0x0d, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, + 0x6d, 0xed, 0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd, 0x03, 0x83, 0x43, + 0xc3, 0x23, 0xa3, 0x63, 0xe3, 0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3, + 0x0b, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb, 0x1b, 0x9b, 0x5b, 0xdb, 0x3b, + 0xbb, 0x7b, 0xfb, 0x07, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7, 0x17, 0x97, + 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7, 0x0f, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, + 0xef, 0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff +}; + +byte oddparity(const byte bt) +{ + return OddParity[bt]; +} + +void oddparity_bytes(const byte* pbtData, const ui32 uiLen, byte* pbtPar) +{ + ui32 uiByteNr; + + // Calculate the parity bits for the command + for (uiByteNr=0; uiByteNr>8)+((ui32N&0xFF000000)>>24)); +} + +ui64 swap_endian64(const void* pui64) +{ + ui64 ui64N = *((ui64*)pui64); + return (((ui64N&0xFF)<<56)+((ui64N&0xFF00)<<40)+((ui64N&0xFF0000)<<24)+((ui64N&0xFF000000)<<8)+((ui64N&0xFF00000000)>>8)+((ui64N&0xFF0000000000)>>24)+((ui64N&0xFF000000000000)>>40)+((ui64N&0xFF00000000000000)>>56)); +} + +void append_iso14443a_crc(byte* pbtData, ui32 uiLen) +{ + byte bt; + ui32 wCrc = 0x6363; + + do { + bt = *pbtData++; + bt = (bt^(byte)(wCrc & 0x00FF)); + bt = (bt^(bt<<4)); + wCrc = (wCrc >> 8)^((ui32)bt << 8)^((ui32)bt<<3)^((ui32)bt>>4); + } while (--uiLen); + + *pbtData++ = (byte) (wCrc & 0xFF); + *pbtData = (byte) ((wCrc >> 8) & 0xFF); +} + +void print_hex(const byte* pbtData, const ui32 uiLen) +{ + ui32 uiPos; + for (uiPos=0; uiPos < uiLen; uiPos++) + { + printf("%02x ",pbtData[uiPos]); + } + printf("\n"); +} + +void print_hex_par(const byte* pbtData, const ui32 uiBits, const byte* pbtDataPar) +{ + ui32 uiPos; + ui32 uiBytes = uiBits/8; + + for (uiPos=0; uiPos < uiBytes; uiPos++) + { + printf("%02x",pbtData[uiPos]); + if (OddParity[pbtData[uiPos]] != pbtDataPar[uiPos]) + { + printf("! "); + } else { + printf(" "); + } + } + + // Print the rest bits, these cannot have no parity bit + if (uiBits%8 != 0) + { + printf("%02x",pbtData[uiBytes]); + } + + printf("\n"); +} + diff --git a/bitutils.h b/bitutils.h new file mode 100644 index 0000000..e231678 --- /dev/null +++ b/bitutils.h @@ -0,0 +1,61 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#ifndef _LIBNFC_BITUTILS_H_ +#define _LIBNFC_BITUTILS_H_ + +#include "defines.h" + +#define INNER_XOR8(n) {\ + n ^= (n >> 4); \ + n ^= (n >> 2); \ + n ^= (n >> 1); \ + n &= 0x01; \ +} + +#define INNER_XOR32(n) {\ + n ^= (n >> 16); \ + n ^= (n >> 8); \ + INNER_XOR8(n); \ +} + +#define INNER_XOR64(n) {\ + n ^= (n >> 32); \ + INNER_XOR32(n); \ +} + +byte oddparity(const byte bt); +void oddparity_bytes(const byte* pbtData, const ui32 uiLen, byte* pbtPar); + +byte mirror(byte bt); +ui32 mirror32(ui32 ui32Bits); +ui64 mirror64(ui64 ui64Bits); +void mirror_bytes(byte *pbts, ui32 uiLen); + +ui32 swap_endian32(const void* pui32); +ui64 swap_endian64(const void* pui64); + +void append_iso14443a_crc(byte* pbtData, ui32 uiLen); + +void print_hex(const byte* pbtData, const ui32 uiLen); +void print_hex_par(const byte* pbtData, const ui32 uiBits, const byte* pbtDataPar); + +#endif // _LIBNFC_BITUTILS_H_ + diff --git a/defines.h b/defines.h new file mode 100644 index 0000000..99edc19 --- /dev/null +++ b/defines.h @@ -0,0 +1,45 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#ifndef _LIBNFC_DEFINES_H_ +#define _LIBNFC_DEFINES_H_ + +typedef unsigned char byte; +typedef unsigned char ui8; +typedef unsigned short ui16; +typedef unsigned int ui32; +typedef unsigned long long ui64; +typedef unsigned long ulong; +typedef char i8; +typedef short i16; +typedef int i32; + +#define null 0 + +typedef void* dev_id; // Device Id +#define INVALID_DEVICE_ID null +#define MAX_FRAME_LEN 264 + +#define min(a,b) (((a) < (b)) ? (a) : (b)) +#define max(a,b) (((a) > (b)) ? (a) : (b)) + +// #define _LIBNFC_VERBOSE_ + +#endif // _LIBNFC_DEFINES_H_ diff --git a/libnfc.c b/libnfc.c new file mode 100644 index 0000000..f832b28 --- /dev/null +++ b/libnfc.c @@ -0,0 +1,524 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include +#include "libnfc.h" +#include "acr122.h" +#include "bitutils.h" + +#define REG_CIU_TX_MODE 0x6302 +#define REG_CIU_RX_MODE 0x6303 +#define REG_CIU_TX_AUTO 0x6305 +#define REG_CIU_MANUAL_RCV 0x630D +#define REG_CIU_CONTROL 0x633C +#define REG_CIU_BIT_FRAMING 0x633D + +#define PARAM_NONE 0x00 +#define PARAM_NAD_USED 0x01 +#define PARAM_DID_USED 0x02 +#define PARAM_AUTO_ATR_RES 0x04 +#define PARAM_AUTO_RATS 0x10 +#define PARAM_14443_4_PICC 0x20 +#define PARAM_NO_AMBLE 0x40 + +// PN532 configuration +byte pncmd_get_firmware_version [ 2] = { 0xD4,0x02 }; +byte pncmd_get_general_status [ 2] = { 0xD4,0x04 }; +byte pncmd_get_register [ 4] = { 0xD4,0x06 }; +byte pncmd_set_register [ 5] = { 0xD4,0x08 }; +byte pncmd_set_parameters [ 3] = { 0xD4,0x12 }; + +// RF field configuration +byte pncmd_rf_configure_field [ 4] = { 0xD4,0x32,0x01 }; +byte pncmd_rf_configure_timing [ 4] = { 0xD4,0x32,0x02 }; +byte pncmd_rf_configure_retry_data [ 4] = { 0xD4,0x32,0x04 }; +byte pncmd_rf_configure_retry_select [ 6] = { 0xD4,0x32,0x05 }; + +// Reader +byte pncmd_reader_list_passive [264] = { 0xD4,0x4A }; +byte pncmd_reader_select [ 3] = { 0xD4,0x54 }; +byte pncmd_reader_deselect [ 3] = { 0xD4,0x44 }; +byte pncmd_reader_release [ 3] = { 0xD4,0x52 }; +byte pncmd_reader_set_baud_rate [ 5] = { 0xD4,0x4E }; +byte pncmd_reader_exchange_data [265] = { 0xD4,0x40 }; +byte pncmd_reader_auto_poll [ 5] = { 0xD4,0x60 }; + +// Target +byte pncmd_target_get_data [ 2] = { 0xD4,0x86 }; +byte pncmd_target_init [ 39] = { 0xD4,0x8C }; +byte pncmd_target_virtual_card [ 4] = { 0xD4,0x14 }; +byte pncmd_target_receive [ 2] = { 0xD4,0x88 }; +byte pncmd_target_send [264] = { 0xD4,0x90 }; +byte pncmd_target_get_status [ 2] = { 0xD4,0x8A }; + +// Exchange raw data frames +byte pncmd_exchange_raw_data [266] = { 0xD4,0x42 }; + +// Global buffers used for communication with the PN532 chip +#define MAX_FRAME_LEN 264 +static byte abtRx[MAX_FRAME_LEN]; +static ui32 uiRxLen; +static ui8 ui8Value; +static ui32 ui32Len = 1; + +bool pn532_transceive(const dev_id di, const byte* pbtTx, const ui32 uiTxLen) +{ + uiRxLen = MAX_FRAME_LEN; + return acr122_transceive(di,pbtTx,uiTxLen,abtRx,&uiRxLen); +} + +bool pn532_set_reg(const dev_id di, ui16 ui16Reg, ui8 ui8Value) +{ + pncmd_set_register[2] = ui16Reg >> 8; + pncmd_set_register[3] = ui16Reg & 0xff; + pncmd_set_register[4] = ui8Value; + return acr122_transceive(di,pncmd_set_register,5,null,null); +} + +byte pn532_get_reg(const dev_id di, ui16 ui16Reg) +{ + pncmd_get_register[2] = ui16Reg >> 8; + pncmd_get_register[3] = ui16Reg & 0xff; + acr122_transceive(di,pncmd_get_register,4,&ui8Value,&ui32Len); + return ui8Value; +} + +bool pn532_set_parameters(const dev_id di, ui8 ui8Value) +{ + pncmd_set_parameters[2] = ui8Value; + return acr122_transceive(di,pncmd_set_parameters,3,null,null); +} + +bool pn532_wrap_frame(const byte* pbtTx, const ui32 uiTxBits, const byte* pbtTxPar, byte* pbtFrame, ui32* puiFrameBits) +{ + byte btFrame; + byte btData; + ui32 uiBitPos; + ui32 uiDataPos = 0; + ui32 uiBitsLeft = uiTxBits; + + // Make sure we should frame at least something + if (uiBitsLeft == 0) return false; + + // Handle a short response (1byte) as a special case + if (uiBitsLeft < 9) + { + *pbtFrame = *pbtTx; + *puiFrameBits = uiTxBits; + return true; + } + + // We start by calculating the frame length in bits + *puiFrameBits = uiTxBits + (uiTxBits/8); + + // Parse the data bytes and add the parity bits + // This is really a sensitive process, mirror the frame bytes and append parity bits + // buffer = mirror(frame-byte) + parity + mirror(frame-byte) + parity + ... + // split "buffer" up in segments of 8 bits again and mirror them + // air-bytes = mirror(buffer-byte) + mirror(buffer-byte) + mirror(buffer-byte) + .. + while(true) + { + // Reset the temporary frame byte; + btFrame = 0; + + for (uiBitPos=0; uiBitPos<8; uiBitPos++) + { + // Copy as much data that fits in the frame byte + btData = mirror(pbtTx[uiDataPos]); + btFrame |= (btData >> uiBitPos); + // Save this frame byte + *pbtFrame = mirror(btFrame); + // Set the remaining bits of the date in the new frame byte and append the parity bit + btFrame = (btData << (8-uiBitPos)); + btFrame |= ((pbtTxPar[uiDataPos] & 0x01) << (7-uiBitPos)); + // Backup the frame bits we have so far + pbtFrame++; + *pbtFrame = mirror(btFrame); + // Increase the data (without parity bit) position + uiDataPos++; + // Test if we are done + if (uiBitsLeft < 9) return true; + uiBitsLeft -= 8; + } + // Every 8 data bytes we lose one frame byte to the parities + pbtFrame++; + } +} + +bool pn532_unwrap_frame(const byte* pbtFrame, const ui32 uiFrameBits, byte* pbtRx, ui32* puiRxBits, byte* pbtRxPar) +{ + byte btFrame; + byte btData; + ui8 uiBitPos; + ui32 uiDataPos = 0; + byte* pbtFramePos = (byte*) pbtFrame; + ui32 uiBitsLeft = uiFrameBits; + + // Make sure we should frame at least something + if (uiBitsLeft == 0) return false; + + // Handle a short response (1byte) as a special case + if (uiBitsLeft < 9) + { + *pbtRx = *pbtFrame; + *puiRxBits = uiFrameBits; + return true; + } + + // Calculate the data length in bits + *puiRxBits = uiFrameBits - (uiFrameBits/9); + + // Parse the frame bytes, remove the parity bits and store them in the parity array + // This process is the reverse of WrapFrame(), look there for more info + while(true) + { + for (uiBitPos=0; uiBitPos<8; uiBitPos++) + { + btFrame = mirror(pbtFramePos[uiDataPos]); + btData = (btFrame << uiBitPos); + btFrame = mirror(pbtFramePos[uiDataPos+1]); + btData |= (btFrame >> (8-uiBitPos)); + pbtRx[uiDataPos] = mirror(btData); + if(pbtRxPar != null) pbtRxPar[uiDataPos] = ((btFrame >> (7-uiBitPos)) & 0x01); + // Increase the data (without parity bit) position + uiDataPos++; + // Test if we are done + if (uiBitsLeft < 9) return true; + uiBitsLeft -= 9; + } + // Every 8 data bytes we lose one frame byte to the parities + pbtFramePos++; + } +} + +bool nfc_configure_handle_crc(const dev_id di, const bool bEnable) +{ + if (bEnable) + { + // Enable automatic receiving/sending of CRC bytes + if (!pn532_set_reg(di,REG_CIU_TX_MODE,pn532_get_reg(di,REG_CIU_TX_MODE) | 0x80)) return false; + if (!pn532_set_reg(di,REG_CIU_RX_MODE,pn532_get_reg(di,REG_CIU_RX_MODE) | 0x80)) return false; + } else { + // Disable automatic receiving/sending of CRC bytes + if (!pn532_set_reg(di,REG_CIU_TX_MODE,pn532_get_reg(di,REG_CIU_TX_MODE) & 0x7f)) return false; + if (!pn532_set_reg(di,REG_CIU_RX_MODE,pn532_get_reg(di,REG_CIU_RX_MODE) & 0x7f)) return false; + } + return true; +} + +bool nfc_configure_handle_parity(const dev_id di, const bool bEnable) +{ + if (bEnable) + { + // Handle parity by chip + if (!pn532_set_reg(di,REG_CIU_MANUAL_RCV,pn532_get_reg(di,REG_CIU_MANUAL_RCV) & 0xef)) return false; + + } else { + // Parse parity as data bit + if (!pn532_set_reg(di,REG_CIU_MANUAL_RCV,pn532_get_reg(di,REG_CIU_MANUAL_RCV) | 0x10)) return false; + } + return true; +} + +bool nfc_configure_field(const dev_id di, const bool bEnable) +{ + pncmd_rf_configure_field[3] = (bEnable) ? 1 : 0; + return acr122_transceive(di,pncmd_rf_configure_field,4,null,null); +} + +bool nfc_configure_list_passive_infinite(const dev_id di, const bool bEnable) +{ + // Retry format: 0x00 means only 1 try, 0xff means infinite + pncmd_rf_configure_retry_select[3] = (bEnable) ? 0xff : 0x00; // MxRtyATR, default: active = 0xff, passive = 0x02 + pncmd_rf_configure_retry_select[4] = (bEnable) ? 0xff : 0x00; // MxRtyPSL, default: 0x01 + pncmd_rf_configure_retry_select[5] = (bEnable) ? 0xff : 0x00; // MxRtyPassiveActivation, default: 0xff + return acr122_transceive(di,pncmd_rf_configure_retry_select,6,null,null); +} + +bool nfc_configure_accept_invalid_frames(const dev_id di, const bool bEnable) +{ + if (bEnable) + { + // Handle parity by chip + if (!pn532_set_reg(di,REG_CIU_RX_MODE,pn532_get_reg(di,REG_CIU_RX_MODE) | 0x08)) return false; + + } else { + // Parse parity as data bit + if (!pn532_set_reg(di,REG_CIU_RX_MODE,pn532_get_reg(di,REG_CIU_RX_MODE) | 0xf7)) return false; + } + return true; +} + +bool nfc_configure_accept_multiple_frames(const dev_id di, const bool bEnable) +{ + if (bEnable) + { + // Handle parity by chip + if (!pn532_set_reg(di,REG_CIU_RX_MODE,pn532_get_reg(di,REG_CIU_RX_MODE) | 0x04)) return false; + + } else { + // Parse parity as data bit + if (!pn532_set_reg(di,REG_CIU_RX_MODE,pn532_get_reg(di,REG_CIU_RX_MODE) | 0xfb)) return false; + } + return true; +} + +bool nfc_reader_init(const dev_id di) +{ + // Try to connect to the NFC reader + if (di == INVALID_DEVICE_ID) return INVALID_DEVICE_ID; + + // Let the PN5XX automatically be activated by the RF level detector + if (!pn532_set_reg(di,REG_CIU_TX_AUTO,pn532_get_reg(di,REG_CIU_TX_AUTO) | 0x40)) return false; + + // Configure the PN532 to be an Initiator or Reader/Writer + if (!pn532_set_reg(di,REG_CIU_CONTROL,pn532_get_reg(di,REG_CIU_CONTROL) | 0x10)) return false; + + return true; +} + +bool nfc_reader_list_passive(const dev_id di, const ModulationType mt, const byte* pbtInitData, const ui32 uiInitDataLen, byte* pbtTag, ui32* puiTagLen) +{ + pncmd_reader_list_passive[2] = 1; // MaxTg, we only want to select 1 tag at the time + pncmd_reader_list_passive[3] = mt; // BrTy, the type of modulation used for polling a passive tag + + // Set the optional initiator data (used for Felica, ISO14443B, Topaz Polling or selecting a specific UID). + if (pbtInitData) memcpy(pncmd_reader_list_passive+4,pbtInitData,uiInitDataLen); + + // Try to find the available tags + if (!acr122_transceive(di,pncmd_reader_list_passive,4+uiInitDataLen,pbtTag,puiTagLen)) return false; + + // Return true only if at least one tag has been found, the PN532 returns 0x00 if none was available + return (pbtTag[0] != 0x00); +} + +bool nfc_reader_transceive_7bits(const dev_id di, const byte btTx, byte* pbtRx, ui32* puiRxLen) +{ + // Set transmission bits to 7 + if (!pn532_set_reg(di,REG_CIU_BIT_FRAMING,7)) return false; + + pncmd_exchange_raw_data[2] = btTx; + if (!pn532_transceive(di,pncmd_exchange_raw_data,3)) return false; + + if (uiRxLen == 1 || abtRx[0] != 0) return false; + *puiRxLen = uiRxLen-1; + memcpy(pbtRx,abtRx+1,*puiRxLen); + + // Reset transmission bits count + if (!pn532_set_reg(di,REG_CIU_BIT_FRAMING,0)) return false; + + return true; +} + +bool nfc_reader_transceive_bytes(const dev_id di, const byte* pbtTx, const ui32 uiTxLen, byte* pbtRx, ui32* puiRxLen) +{ + memcpy(pncmd_exchange_raw_data+2,pbtTx,uiTxLen); + + if (!pn532_transceive(di,pncmd_exchange_raw_data,2+uiTxLen)) return false; + + if (uiRxLen == 1 || abtRx[0] != 0) return false; + *puiRxLen = uiRxLen-1; + memcpy(pbtRx,abtRx+1,*puiRxLen); + + return true; +} + +bool nfc_reader_transceive_bits(const dev_id di, const byte* pbtTx, const ui32 uiTxBits, const byte* pbtTxPar, byte* pbtRx, ui32* puiRxBits, byte* pbtRxPar) +{ + ui32 uiFrameBits = 0; + ui8 ui8Bits = 0; + + // Convert data to a frame + pn532_wrap_frame(pbtTx,uiTxBits,pbtTxPar,pncmd_exchange_raw_data+2,&uiFrameBits); + + // Retrieve the resting bits + ui8Bits = uiFrameBits%8; + + // Set the amount of transmission bits in the pn532 chip register + if (!pn532_set_reg(di,REG_CIU_BIT_FRAMING,ui8Bits)) return false; + + // Send the frame to the pn532 chip and get the answer + // We have to give the amount of bytes + 1 byte if there are leading bits + the two 0xD4,0x42 + if (!pn532_transceive(di,pncmd_exchange_raw_data,(uiFrameBits/8)+((ui8Bits==0)?0:1)+2)) return false; + + // Make sure there was no failure reported by the PN532 chip (0 == OK) + // TODO: is this ACR122 specific? + if (uiRxLen == 1 || abtRx[0] != 0) return false; + + // Get the last bit-count that is stored in the received byte + ui8Bits = pn532_get_reg(di,REG_CIU_CONTROL) & 0x07; + + // Unwrap the response frame + pn532_unwrap_frame(abtRx+1,((uiRxLen-1-((ui8Bits==0)?0:1))*8)+ui8Bits,pbtRx,puiRxBits,pbtRxPar); + + // Everything went successful + return true; +} + +bool nfc_reader_mifare_cmd(const dev_id di, const MifareCmd mc, const ui8 ui8Block, MifareParam* pmp) +{ + ui32 uiParamLen; + pncmd_reader_exchange_data[2] = 0x01; // Use first target/card + pncmd_reader_exchange_data[3] = mc; // The MIFARE Classic command + pncmd_reader_exchange_data[4] = ui8Block; // The block address (1K=0x00..0x39, 4K=0x00..0xff) + + switch (mc) + { + // Read and store command have no parameter + case MC_READ: + case MC_STORE: + uiParamLen = 0; + break; + + // Authenticate command + case MC_AUTH_A: + case MC_AUTH_B: + uiParamLen = sizeof(MifareParamAuth); + break; + + // Data command + case MC_WRITE: + uiParamLen = sizeof(MifareParamData); + break; + + // Value command + case MC_DECREMENT: + case MC_INCREMENT: + case MC_TRANSFER: + uiParamLen = sizeof(MifareParamValue); + break; + + // Please fix your code, you never should reach this statement + default: + return false; + break; + } + + // When available, copy the parameter bytes + if (uiParamLen) memcpy(pncmd_reader_exchange_data+5,(byte*)pmp,uiParamLen); + + // Fire the mifare command + if (!pn532_transceive(di,pncmd_reader_exchange_data,5+uiParamLen)) return false; + + // Make sure there was no failure reported by the PN532 chip (0 == OK) + // TODO: is this ACR122 specific? + if (abtRx[0] != 0) return false; + + // When we have executed a read command, copy the received bytes into the param + if (mc == MC_READ) memcpy(pmp->mpd.abtData,abtRx+1,16); + + // Command succesfully executed + return true; +} + +bool nfc_target_init(const dev_id di, byte* pbtRx, ui32* puiRxLen) +{ + // Clear the target init struct, reset to all zeros + memset(pncmd_target_init+2,0x00,37); + + // Set ATQA (SENS_RES) + pncmd_target_init[3] = 0x04; + pncmd_target_init[4] = 0x00; + + // Set SAK (SEL_RES) + pncmd_target_init[8] = 0x20; + + // Set UID + pncmd_target_init[5] = 0x00; + pncmd_target_init[6] = 0xb0; + pncmd_target_init[7] = 0x0b; + + // Enable CRC & parity, needed for target_init to work properly + nfc_configure_handle_crc(di,true); + nfc_configure_handle_parity(di,true); + + // Request the initialization as a target + if (!pn532_transceive(di,pncmd_target_init,39)) return false; + + if (uiRxLen == 1 || abtRx[0] != 0) return false; + *puiRxLen = uiRxLen-1; + memcpy(pbtRx,abtRx+1,*puiRxLen); + + return true; +} + +bool nfc_target_receive_bytes(const dev_id di, byte* pbtRx, ui32* puiRxLen) +{ + if (!pn532_transceive(di,pncmd_target_receive,2)) return false; + + if (uiRxLen == 1 || abtRx[0] != 0) return false; + *puiRxLen = uiRxLen-1; + memcpy(pbtRx,abtRx+1,*puiRxLen); + + return true; +} + +bool nfc_target_receive_bits(const dev_id di, byte* pbtRx, ui32* puiRxBits, byte* pbtRxPar) +{ + ui8 ui8Bits; + + // Try to gather the received frames from the reader + if (!pn532_transceive(di,pncmd_target_receive,2)) return false; + + // Make sure there was no failure reported by the PN532 chip (0 == OK) + // TODO: is this ACR122 specific? + if (uiRxLen == 1 || abtRx[0] != 0) return false; + + // Get the last bit-count that is stored in the received byte + ui8Bits = pn532_get_reg(di,REG_CIU_CONTROL) & 0x07; + + // Unwrap the response frame + pn532_unwrap_frame(abtRx+1,((uiRxLen-1-((ui8Bits==0)?0:1))*8)+ui8Bits,pbtRx,puiRxBits,pbtRxPar); + + return true; +} + +bool nfc_target_send_bytes(const dev_id di, const byte* pbtTx, const ui32 uiTxLen) +{ + memcpy(pncmd_target_send+2,pbtTx,uiTxLen); + return acr122_transceive(di,pncmd_target_send,2+uiTxLen,null,null); +} + +bool nfc_target_send_bits(const dev_id di, const byte* pbtTx, const ui32 uiTxBits, const byte* pbtTxPar) +{ + ui32 uiFrameBits = 0; + ui8 ui8Bits = 0; + + // Convert data to a frame + pn532_wrap_frame(pbtTx,uiTxBits,pbtTxPar,pncmd_target_send+2,&uiFrameBits); + + // Retrieve the resting bits + ui8Bits = uiFrameBits%8; + + // Set the amount of transmission bits in the pn532 chip register + if (!pn532_set_reg(di,REG_CIU_BIT_FRAMING,ui8Bits)) return false; + + // Try to send the bits to the reader + if (!pn532_transceive(di,pncmd_target_send,(uiFrameBits/8)+((ui8Bits==0)?0:1)+2)) return false; + + // Make sure there was no failure reported by the PN532 chip (0 == OK) + // TODO: is this ACR122 specific? + if (uiRxLen == 1 || abtRx[0] != 0) return false; + + // Everyting seems ok, return true + return true; +} + diff --git a/libnfc.h b/libnfc.h new file mode 100644 index 0000000..ba8802a --- /dev/null +++ b/libnfc.h @@ -0,0 +1,50 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#ifndef _LIBNFC_H_ +#define _LIBNFC_H_ + +#include "defines.h" +#include "types.h" +#include "bitutils.h" +#include "acr122.h" + +bool nfc_configure_handle_crc(const dev_id di, const bool bEnable); +bool nfc_configure_handle_parity(const dev_id di, const bool bEnable); +bool nfc_configure_field(const dev_id di, const bool bEnable); +bool nfc_configure_list_passive_infinite(const dev_id di, const bool bEnable); +bool nfc_configure_accept_invalid_frames(const dev_id di, const bool bEnable); +bool nfc_configure_accept_multiple_frames(const dev_id di, const bool bEnable); + +bool nfc_reader_init(const dev_id di); +bool nfc_reader_list_passive(const dev_id di, const ModulationType mt, const byte* pbtInitData, const ui32 uiInitDataLen, byte* pbtTag, ui32* puiTagLen); +bool nfc_reader_transceive_7bits(const dev_id di, const byte btTx, byte* pbtRx, ui32* puiRxLen); +bool nfc_reader_transceive_bytes(const dev_id di, const byte* pbtTx, const ui32 uiTxLen, byte* pbtRx, ui32* puiRxLen); +bool nfc_reader_transceive_bits(const dev_id di, const byte* pbtTx, const ui32 uiTxBits, const byte* pbtTxPar, byte* pbtRx, ui32* puiRxBits, byte* pbtRxPar); +bool nfc_reader_mifare_cmd(const dev_id di, const MifareCmd mc, const ui8 ui8Block, MifareParam* pmp); + +bool nfc_target_init(const dev_id di, byte* pbtRx, ui32* puiRxLen); +bool nfc_target_receive_bytes(const dev_id di, byte* pbtRx, ui32* puiRxLen); +bool nfc_target_receive_bits(const dev_id di, byte* pbtRx, ui32* puiRxBits, byte* pbtRxPar); +bool nfc_target_send_bytes(const dev_id di, const byte* pbtTx, const ui32 uiTxLen); +bool nfc_target_send_bits(const dev_id di, const byte* pbtTx, const ui32 uiTxBits, const byte* pbtTxPar); + +#endif // _LIBNFC_H_ + diff --git a/list.c b/list.c new file mode 100644 index 0000000..7cb111b --- /dev/null +++ b/list.c @@ -0,0 +1,83 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include +#include +#include "libnfc.h" + +static byte abtRecv[MAX_FRAME_LEN]; +static ui32 uiRecvLen; +static dev_id di; + +int main(int argc, const char* argv[]) +{ + // Try to open the NFC reader + di = acr122_connect(0); + + if (di == INVALID_DEVICE_ID) + { + printf("Error connecting NFC reader\n"); + return 1; + } + nfc_reader_init(di); + + // Let the reader only try once to find a tag + nfc_configure_list_passive_infinite(di,false); + + // Drop the field so the tag will be reset + nfc_configure_field(di,false); + + // Configure the communication channel + nfc_configure_handle_crc(di,true); + nfc_configure_handle_parity(di,true); + + printf("\nConnected to NFC reader\n\n"); + + uiRecvLen = MAX_FRAME_LEN; + if (nfc_reader_list_passive(di,MT_ISO14443A_106,null,null,abtRecv,&uiRecvLen)) + { + // ISO14443A tag info = ( tag_count[1], tag_nr[1], ATQA[2], SAK[1], uid_len[1], UID[uid_len], ats_len[1], ATS[ats_len-1] ) + // ATS is optional + printf("The following (NFC) ISO14443A tag was found:\n\n"); + printf("%17s","ATQA (SENS_RES): "); + print_hex(abtRecv+2,2); + printf("%17s","UID (NFCID1): "); + print_hex(abtRecv+6,abtRecv[5]); + printf("%17s","SAK (SEL_RES): "); + print_hex(abtRecv+4,1); + if (uiRecvLen > 6+(ui32)abtRecv[5]) + { + printf("%17s","ATS (ATR): "); + print_hex(abtRecv+6+abtRecv[5]+1,abtRecv[6+abtRecv[5]]-1); + } + } else { + printf("Error: no tag was found\n"); + } + + // Todo: listing the folllowing tags types + // + // MT_FELICA_212 + // MT_FELICA_424 + // MT_ISO14443B_106 + // MT_TOPAZ_106 + + return 0; +} diff --git a/mfread.c b/mfread.c new file mode 100644 index 0000000..ce0ad2f --- /dev/null +++ b/mfread.c @@ -0,0 +1,225 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#define _CRT_SECURE_NO_WARNINGS + +#include +#include +#include + +#include "libnfc.h" +#include "mifaretag.h" + +static byte abtRecv[MAX_FRAME_LEN]; +static ui32 uiRecvLen; +static dev_id di; +static MifareParam mp; +static MifareTag mtKeys; +static MifareTag mtDump; + +bool is_trailer_block(ui32 uiBlock) +{ + // Test if we are in the small or big sectors + if (uiBlock < 128) return ((uiBlock+1)%4 == 0); else return ((uiBlock+1)%16 == 0); +} + +ui32 get_trailer_block(ui32 uiSector) +{ + // Test if we are in the small or big sectors + if (uiSector<32) + { + return (uiSector*4)+3; + } else { + return 128+((uiSector-32)*16)+15; + } +} + +int main(int argc, const char* argv[]) +{ + bool b4K; + bool bKeyA; + byte* pbtUID; + bool bFailure; + i32 iBlock; + ui32 uiBlocks; + FILE* pfKeys; + FILE* pfDump; + MifareCmd mc; + + if (argc < 4) + { + printf("mfread \n"); + printf("\n"); + return 1; + } + + bKeyA = (*(argv[1]) == 'a'); + + pfKeys = fopen(argv[2],"rb"); + if (pfKeys == null) + { + printf("Could not open file: %s\n",argv[2]); + return 1; + } + fread(&mtKeys,1,sizeof(mtKeys),pfKeys); + fclose(pfKeys); + + pfDump = fopen(argv[3],"wb"); + if (pfKeys == null) + { + printf("Could not open file: %s\n",argv[3]); + return 1; + } + memset(&mtDump,0x00,sizeof(mtDump)); + printf("Succesful opened MIFARE dump files\n"); + + // Try to open the NFC reader + di = acr122_connect(0); + if (di == INVALID_DEVICE_ID) + { + printf("Error connecting NFC reader\n"); + return 1; + } + nfc_reader_init(di); + // Let the reader only try once to find a tag + nfc_configure_list_passive_infinite(di,false); + + // Drop the field so the tag will be reset + nfc_configure_field(di,false); + + // Configure the communication channel + nfc_configure_handle_crc(di,true); + nfc_configure_handle_parity(di,true); + printf("Connected to NFC reader\n"); + + // MIFARE Classic tag info = ( tag_count[1], tag_nr[1], ATQA[2], SAK[1], uid_len[1], UID[uid_len] ) + uiRecvLen = MAX_FRAME_LEN; + if (!nfc_reader_list_passive(di,MT_ISO14443A_106,null,null,abtRecv,&uiRecvLen)) + { + printf("Error: no tag was found\n"); + return 1; + } + + // Test if we are dealing with a MIFARE compatible tag + if ((abtRecv[4] & 0x08) == 0) + { + printf("Error: tag is not a MIFARE Classic card\n"); + return 1; + } + + // Get the info from the key dump + b4K = (mtKeys.blContent[0].bm.abtATQA[0] == 0x02); + pbtUID = mtKeys.blContent[0].bm.abtUID; + + // Compare if key dump UID is the same as the current tag UID + if (memcmp(abtRecv+6,pbtUID,4) != 0) + { + printf("Expected MIFARE Classic %cK card with uid: %08x\n",b4K?'4':'1',swap_endian32(pbtUID)); + } + + // Get the info from the current tag + pbtUID = abtRecv+6; + b4K = (abtRecv[3] == 0x02); + printf("Found MIFARE Classic %cK card with uid: %08x\n",b4K?'4':'1',swap_endian32(pbtUID)); + + uiBlocks = (b4K)?0xff:0x3f; + bFailure = false; + printf("Reading out %d blocks |",uiBlocks+1); + + // Read the card from end to begin + for (iBlock=uiBlocks; iBlock>=0; iBlock--) + { + // Authenticate everytime we reach a trailer block + if (is_trailer_block(iBlock)) + { + // Show if the readout went well + if (bFailure) + { + printf("x"); + // When a failure occured we need to redo the anti-collision + if (!nfc_reader_list_passive(di,MT_ISO14443A_106,null,null,abtRecv,&uiRecvLen)) + { + printf("!\nError: tag was removed\n"); + return 1; + } + bFailure = false; + } else { + // Skip this the first time, bFailure it means nothing (yet) + if (iBlock != uiBlocks) + { + printf("."); + } + } + fflush(stdout); + + // Set the authentication information (uid) + memcpy(mp.mpa.abtUid,abtRecv+6,4); + + // Determin if we should use the a or the b key + if (bKeyA) + { + mc = MC_AUTH_A; + memcpy(mp.mpa.abtKey,mtKeys.blContent[iBlock].bt.abtKeyA,6); + } else { + mc = MC_AUTH_B; + memcpy(mp.mpa.abtKey,mtKeys.blContent[iBlock].bt.abtKeyB,6); + } + + // Try to authenticate for the current sector + if (!nfc_reader_mifare_cmd(di,MC_AUTH_A,iBlock,&mp)) + { + printf("!\nError: authentication failed for block %02x\n",iBlock); + return 1; + } + + // Try to read out the trailer + if (nfc_reader_mifare_cmd(di,MC_READ,iBlock,&mp)) + { + // Copy the keys over from our key dump and store the retrieved access bits + memcpy(mtDump.blContent[iBlock].bd.abtContent,mtKeys.blContent[iBlock].bt.abtKeyA,6); + memcpy(mtDump.blContent[iBlock].bt.abtAccessBits,mp.mpd.abtData+6,4); + memcpy(mtDump.blContent[iBlock].bd.abtContent+10,mtKeys.blContent[iBlock].bt.abtKeyB,6); + } + } else { + // Make sure a earlier readout did not fail + if (!bFailure) + { + // Try to read out the data block + if (nfc_reader_mifare_cmd(di,MC_READ,iBlock,&mp)) + { + memcpy(mtDump.blContent[iBlock].bd.abtContent,mp.mpd.abtData,16); + } else { + bFailure = true; + } + } + } + } + printf("%c|\n",(bFailure)?'x':'.'); + fflush(stdout); + + printf("Writing dump to file: %s\n",argv[3]); + fflush(stdout); + fwrite(&mtDump,1,sizeof(mtDump),pfDump); + fclose(pfKeys); + + printf("Done, all data is dumped!\n"); + + return 0; +} diff --git a/mfwrite.c b/mfwrite.c new file mode 100644 index 0000000..82e44af --- /dev/null +++ b/mfwrite.c @@ -0,0 +1,232 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#define _CRT_SECURE_NO_WARNINGS + +#include +#include +#include + +#include "libnfc.h" +#include "mifaretag.h" + +static byte abtRecv[MAX_FRAME_LEN]; +static ui32 uiRecvLen; +static dev_id di; +static MifareParam mp; +static MifareTag mtKeys; +static MifareTag mtDump; + +bool is_first_block(ui32 uiBlock) +{ + // Test if we are in the small or big sectors + if (uiBlock < 128) return ((uiBlock)%4 == 0); else return ((uiBlock)%16 == 0); +} + +bool is_trailer_block(ui32 uiBlock) +{ + // Test if we are in the small or big sectors + if (uiBlock < 128) return ((uiBlock+1)%4 == 0); else return ((uiBlock+1)%16 == 0); +} + +ui32 get_trailer_block(ui32 uiFirstBlock) +{ + // Test if we are in the small or big sectors + if (uiFirstBlock<128) return uiFirstBlock+3; else return uiFirstBlock+15; +} + +int main(int argc, const char* argv[]) +{ + bool b4K; + bool bKeyA; + byte* pbtUID; + bool bFailure; + ui32 uiBlock; + ui32 uiBlocks; + ui32 uiTrailerBlock; + FILE* pfKeys; + FILE* pfDump; + MifareCmd mc; + + if (argc < 4) + { + printf("mfwrite \n"); + printf("\n"); + return 1; + } + + bKeyA = (*(argv[1]) == 'a'); + + pfKeys = fopen(argv[2],"rb"); + if (pfKeys == null) + { + printf("Could not open file: %s\n",argv[2]); + return 1; + } + fread(&mtKeys,1,sizeof(mtKeys),pfKeys); + fclose(pfKeys); + + pfDump = fopen(argv[3],"rb"); + if (pfKeys == null) + { + printf("Could not open file: %s\n",argv[3]); + return 1; + } + fread(&mtDump,1,sizeof(mtDump),pfDump); + fclose(pfDump); + printf("Succesful opened MIFARE dump files\n"); + + // Try to open the NFC reader + di = acr122_connect(0); + if (di == INVALID_DEVICE_ID) + { + printf("Error connecting NFC reader\n"); + return 1; + } + nfc_reader_init(di); + // Let the reader only try once to find a tag + nfc_configure_list_passive_infinite(di,false); + + // Drop the field so the tag will be reset + nfc_configure_field(di,false); + + // Configure the communication channel + nfc_configure_handle_crc(di,true); + nfc_configure_handle_parity(di,true); + printf("Connected to NFC reader\n"); + + // MIFARE Classic tag info = ( tag_count[1], tag_nr[1], ATQA[2], SAK[1], uid_len[1], UID[uid_len] ) + uiRecvLen = MAX_FRAME_LEN; + if (!nfc_reader_list_passive(di,MT_ISO14443A_106,null,null,abtRecv,&uiRecvLen)) + { + printf("Error: no tag was found\n"); + return 1; + } + + // Test if we are dealing with a MIFARE compatible tag + if ((abtRecv[4] & 0x08) == 0) + { + printf("Error: tag is not a MIFARE Classic card\n"); + return 1; + } + + // Get the info from the key dump + b4K = (mtKeys.blContent[0].bm.abtATQA[0] == 0x02); + pbtUID = mtKeys.blContent[0].bm.abtUID; + + // Compare if key dump UID is the same as the current tag UID + if (memcmp(abtRecv+6,pbtUID,4) != 0) + { + printf("Expected MIFARE Classic %cK card with uid: %08x\n",b4K?'4':'1',swap_endian32(pbtUID)); + } + + // Get the info from the current tag + pbtUID = abtRecv+6; + b4K = (abtRecv[3] == 0x02); + printf("Found MIFARE Classic %cK card with uid: %08x\n",b4K?'4':'1',swap_endian32(pbtUID)); + + uiBlocks = (b4K)?0xff:0x3f; + bFailure = false; + printf("Writing %d blocks |",uiBlocks+1); + + // Write the card from begin to end; + for (uiBlock=0; uiBlock<=uiBlocks; uiBlock++) + { + // Authenticate everytime we reach the first sector of a new block + if (is_first_block(uiBlock)) + { + // Show if the readout went well + if (bFailure) + { + printf("x"); + // When a failure occured we need to redo the anti-collision + if (!nfc_reader_list_passive(di,MT_ISO14443A_106,null,null,abtRecv,&uiRecvLen)) + { + printf("!\nError: tag was removed\n"); + return 1; + } + bFailure = false; + } else { + // Skip this the first time, bFailure it means nothing (yet) + if (uiBlock != 0) + { + printf("."); + } + } + fflush(stdout); + + // Locate the trailer (with the keys) used for this sector + uiTrailerBlock = get_trailer_block(uiBlock); + + // Set the authentication information (uid) + memcpy(mp.mpa.abtUid,abtRecv+6,4); + + // Determin if we should use the a or the b key + if (bKeyA) + { + mc = MC_AUTH_A; + memcpy(mp.mpa.abtKey,mtKeys.blContent[uiTrailerBlock].bt.abtKeyA,6); + } else { + mc = MC_AUTH_B; + memcpy(mp.mpa.abtKey,mtKeys.blContent[uiTrailerBlock].bt.abtKeyB,6); + } + + // Try to authenticate for the current sector + if (!nfc_reader_mifare_cmd(di,mc,uiBlock,&mp)) + { + printf("!\nError: authentication failed for block %02x\n",uiBlock); + return 1; + } + } + + if (is_trailer_block(uiBlock)) + { + // Copy the keys over from our key dump and store the retrieved access bits + memcpy(mp.mpd.abtData,mtDump.blContent[uiBlock].bt.abtKeyA,6); + memcpy(mp.mpd.abtData+6,mtDump.blContent[uiBlock].bt.abtAccessBits,4); + memcpy(mp.mpd.abtData+10,mtDump.blContent[uiBlock].bt.abtKeyB,6); + + // Try to write the trailer + nfc_reader_mifare_cmd(di,MC_WRITE,uiBlock,&mp); + + } else { + + // The first block 0x00 is read only, skip this + if (uiBlock == 0) continue; + + // Make sure a earlier write did not fail + if (!bFailure) + { + // Try to write the data block + memcpy(mp.mpd.abtData,mtDump.blContent[uiBlock].bd.abtContent,16); + if (!nfc_reader_mifare_cmd(di,MC_WRITE,uiBlock,&mp)) + { + bFailure = true; + } + } + } + } + printf("%c|\n",(bFailure)?'x':'.'); + fflush(stdout); + + printf("Done, all data is written!\n"); + + return 0; +} diff --git a/mifaretag.h b/mifaretag.h new file mode 100644 index 0000000..f6bc772 --- /dev/null +++ b/mifaretag.h @@ -0,0 +1,54 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#ifndef _MIFARE_TAG_H_ +#define _MIFARE_TAG_H_ + +#include "defines.h" + +typedef struct tagBlockManufacturer { + byte abtUID[4]; + byte btBCC; + byte btUnknown; + byte abtATQA[2]; + byte abtUnknown[8]; +} BlockManufacturer; + +typedef struct tagBlockData { + byte abtContent[16]; +} BlockData; + +typedef struct tagBlockTrailer { + byte abtKeyA[6]; + byte abtAccessBits[4]; + byte abtKeyB[6]; +} BlockTrailer; + +typedef union tagBlock { + BlockManufacturer bm; + BlockData bd; + BlockTrailer bt; +} Block; + +typedef struct tagMifareTag { + Block blContent[256]; +} MifareTag; + +#endif // _MIFARE_TAG_H_ diff --git a/relay.c b/relay.c new file mode 100644 index 0000000..f6295bd --- /dev/null +++ b/relay.c @@ -0,0 +1,107 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include +#include +#include "libnfc.h" + +static byte abtReaderRecv[MAX_FRAME_LEN]; +static byte abtReaderRecvPar[MAX_FRAME_LEN]; +static ui32 uiReaderRecvBits; +static byte abtTagRecv[MAX_FRAME_LEN]; +static byte abtTagRecvPar[MAX_FRAME_LEN]; +static ui32 uiTagRecvBits; +static dev_id diReader; +static dev_id diTag; + +int main(int argc, const char* argv[]) +{ + // Try to open the NFC reader + diReader = acr122_connect(0); + if (diReader == INVALID_DEVICE_ID) + { + printf("Error connecting first NFC reader\n"); + return 1; + } + + diTag = acr122_connect(1); + if (diTag == INVALID_DEVICE_ID) + { + printf("Error connecting second NFC reader\n"); + return 1; + } + + printf("\n"); + printf("[+] Connected to the both NFC readers\n"); + acr122_led_red(diTag,true); + printf("[+] Identified simulated tag by setting the red light\n"); + printf("[+] Place both readers on top of each other\n"); + printf("[+] Please run 'anticol' tool in a different shell\n"); + nfc_target_init(diTag,abtReaderRecv,&uiReaderRecvBits); + nfc_configure_handle_crc(diTag,false); + nfc_configure_handle_parity(diTag,false); + nfc_configure_accept_invalid_frames(diTag,true); + printf("[+] Thank you, the simulated tag is initialized\n"); + + printf("[+] Attaching to first NFC reader \n"); + // Retry until it becomes ready + while (!nfc_reader_init(diReader)) + { + acr122_disconnect(diReader); + printf("error\n"); + diReader = acr122_connect(0); + } + nfc_configure_handle_crc(diReader,false); + nfc_configure_handle_parity(diReader,false); + nfc_configure_accept_invalid_frames(diReader,true); + printf("[+] Done, relaying frames now!\n\n"); + + while(true) + { + // Test if we received a frame from the reader + if (nfc_target_receive_bits(diTag,abtReaderRecv,&uiReaderRecvBits,abtReaderRecvPar)) + { + // Drop down the field before sending a REQA command and start a new session + if (uiReaderRecvBits == 7 && abtReaderRecv[0] == 0x26) + { + // Drop down field for a very short time (tag will reboot) + nfc_configure_field(diReader,false); + printf("\n"); + nfc_configure_field(diReader,true); + } + + // Print the reader frame to the screen + printf("R: "); + print_hex_par(abtReaderRecv,uiReaderRecvBits,abtReaderRecvPar); + + // Forward the frame to the original tag + if (nfc_reader_transceive_bits(diReader,abtReaderRecv,uiReaderRecvBits,abtReaderRecvPar,abtTagRecv,&uiTagRecvBits,abtTagRecvPar)) + { + // Redirect the answer back to the reader + nfc_target_send_bits(diTag,abtTagRecv,uiTagRecvBits,abtTagRecvPar); + + // Print the tag frame to the screen + printf("T: "); + print_hex_par(abtTagRecv,uiTagRecvBits,abtTagRecvPar); + } + } + } +} diff --git a/simulate.c b/simulate.c new file mode 100644 index 0000000..ad522a1 --- /dev/null +++ b/simulate.c @@ -0,0 +1,108 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#include +#include +#include +#include "libnfc.h" + +static byte abtRecv[MAX_FRAME_LEN]; +static ui32 uiRecvLen; +static dev_id di; + +// ISO14443A Anti-Collision response +byte abtAtqa [2] = { 0x04,0x00 }; +byte abtUidBcc [5] = { 0xDE,0xAD,0xBE,0xAF,0x62 }; +byte abtSak [9] = { 0x08,0xb6,0xdd }; + +int main(int argc, const char* argv[]) +{ + byte* pbtTx; + ui32 uiTxLen; + + // Try to open the NFC reader + di = acr122_connect(0); + + if (di == INVALID_DEVICE_ID) + { + printf("Error connecting NFC reader\n"); + return 1; + } + + printf("\n"); + printf("[+] Connected to NFC target\n"); + acr122_led_red(di,true); + printf("[+] Identified simulated tag by setting the red light\n"); + printf("[+] First we have to come out auto-simulation\n"); + printf("[+] To do this, please send any command after the\n"); + printf("[+] anti-collision, for example, the RATS command\n\n"); + nfc_target_init(di,abtRecv,&uiRecvLen); + printf("[+] Initiator command: "); + print_hex(abtRecv,uiRecvLen); + printf("[+] Configuring communication"); + nfc_configure_accept_invalid_frames(di,true); + nfc_configure_handle_crc(di,false); + printf("[+] Done, the simulated tag is initialized \n"); + + + while(true) + { + // Test if we received a frame + if (nfc_target_receive_bytes(di,abtRecv,&uiRecvLen)) + { + // Prepare the command to send back for the anti-collision request + switch(uiRecvLen) + { + case 1: // Request or Wakeup + pbtTx = abtAtqa; + uiTxLen = 2; + // New anti-collsion session started + printf("\n"); + break; + + case 2: // Select All + pbtTx = abtUidBcc; + uiTxLen = 5; + break; + + case 9: // Select Tag + pbtTx = abtSak; + uiTxLen = 3; + break; + + default: // unknown length? + uiTxLen = 0; + break; + } + + printf("R: "); + print_hex(abtRecv,uiRecvLen); + + // Test if we know how to respond + if(uiTxLen) + { + // Send and print the command to the screen + nfc_target_send_bytes(di,pbtTx,uiTxLen); + printf("T: "); + print_hex(pbtTx,uiTxLen); + } + } + } +} diff --git a/types.h b/types.h new file mode 100644 index 0000000..cba978e --- /dev/null +++ b/types.h @@ -0,0 +1,69 @@ +/* + +Public platform independent Near Field Communication (NFC) library +Copyright (C) 2009, Roel Verdult + +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 . + +*/ + +#ifndef _LIBNFC_TYPES_H_ +#define _LIBNFC_TYPES_H_ + +#include "defines.h" + +typedef enum { + false = 0x00, + true = 0x01 +}bool; + +typedef enum { + MT_ISO14443A_106 = 0x00, + MT_FELICA_212 = 0x01, + MT_FELICA_424 = 0x02, + MT_ISO14443B_106 = 0x03, + MT_TOPAZ_106 = 0x04, +}ModulationType; + +typedef enum { + MC_AUTH_A = 0x60, + MC_AUTH_B = 0x61, + MC_READ = 0x30, + MC_WRITE = 0xA0, + MC_TRANSFER = 0xB0, + MC_DECREMENT = 0xC0, + MC_INCREMENT = 0xC1, + MC_STORE = 0xC2, +}MifareCmd; + +typedef struct { + byte abtKey[6]; + byte abtUid[4]; +}MifareParamAuth; + +typedef struct { + byte abtData[16]; +}MifareParamData; + +typedef struct { + byte abtValue[4]; +}MifareParamValue; + +typedef union { + MifareParamAuth mpa; + MifareParamData mpd; + MifareParamValue mpv; +}MifareParam; + +#endif // _LIBNFC_TYPES_H_ diff --git a/win32/WINSCARD.LIB b/win32/WINSCARD.LIB new file mode 100644 index 0000000..0e423ed Binary files /dev/null and b/win32/WINSCARD.LIB differ diff --git a/win32/anticol.vcproj b/win32/anticol.vcproj new file mode 100644 index 0000000..3e27c8a --- /dev/null +++ b/win32/anticol.vcproj @@ -0,0 +1,184 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32/libnfc.def b/win32/libnfc.def new file mode 100644 index 0000000..a533130 --- /dev/null +++ b/win32/libnfc.def @@ -0,0 +1,41 @@ +EXPORTS + ; acr122.c + acr122_connect + acr122_disconnect + acr122_transceive + acr122_firmware + acr122_led_red + + ; libnfc.c + nfc_configure_handle_crc + nfc_configure_handle_parity + nfc_configure_field + nfc_configure_list_passive_infinite + nfc_configure_accept_invalid_frames + nfc_configure_accept_multiple_frames + nfc_reader_init + nfc_reader_transceive_7bits + nfc_reader_transceive_bytes + nfc_reader_transceive_bits + nfc_reader_list_passive + nfc_reader_mifare_cmd + nfc_target_init + nfc_target_receive_bytes + nfc_target_receive_bits + nfc_target_send_bytes + nfc_target_send_bits + + ; bitutils.c + oddparity + oddparity_bytes + mirror + mirror32 + mirror64 + mirror_bytes + swap_endian32 + swap_endian64 + append_iso14443a_crc + print_hex + print_hex_par + + \ No newline at end of file diff --git a/win32/libnfc.sln b/win32/libnfc.sln new file mode 100644 index 0000000..674c726 --- /dev/null +++ b/win32/libnfc.sln @@ -0,0 +1,74 @@ + +Microsoft Visual Studio Solution File, Format Version 9.00 +# Visual Studio 2005 +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libnfc", "libnfc.vcproj", "{AAEEDA5F-F86F-452D-BFA3-53B1C00B8884}" +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "anticol", "anticol.vcproj", "{71722DBB-4253-4D68-A29C-AA159360FCE4}" + ProjectSection(ProjectDependencies) = postProject + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} = {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} + EndProjectSection +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "simulate", "simulate.vcproj", "{9F813EB4-8F43-4E58-8C62-8E43D9AC137D}" + ProjectSection(ProjectDependencies) = postProject + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} = {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} + EndProjectSection +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "relay", "relay.vcproj", "{9CC505F9-AE58-4827-8921-A59E7C4839FE}" + ProjectSection(ProjectDependencies) = postProject + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} = {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} + EndProjectSection +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "list", "list.vcproj", "{ADB1806A-745E-4DB4-9CDC-51658A5061E1}" + ProjectSection(ProjectDependencies) = postProject + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} = {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} + EndProjectSection +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "mfread", "mfread.vcproj", "{BB0A837B-DAEF-4B3F-AF5B-9A757A97FFF3}" + ProjectSection(ProjectDependencies) = postProject + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} = {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} + EndProjectSection +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "mfwrite", "mfwrite.vcproj", "{77907F3D-BA6E-4A7F-AF9D-4F60C0A79952}" + ProjectSection(ProjectDependencies) = postProject + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} = {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884} + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Win32 = Debug|Win32 + Release|Win32 = Release|Win32 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884}.Debug|Win32.ActiveCfg = Debug|Win32 + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884}.Debug|Win32.Build.0 = Debug|Win32 + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884}.Release|Win32.ActiveCfg = Release|Win32 + {AAEEDA5F-F86F-452D-BFA3-53B1C00B8884}.Release|Win32.Build.0 = Release|Win32 + {71722DBB-4253-4D68-A29C-AA159360FCE4}.Debug|Win32.ActiveCfg = Debug|Win32 + {71722DBB-4253-4D68-A29C-AA159360FCE4}.Debug|Win32.Build.0 = Debug|Win32 + {71722DBB-4253-4D68-A29C-AA159360FCE4}.Release|Win32.ActiveCfg = Release|Win32 + {71722DBB-4253-4D68-A29C-AA159360FCE4}.Release|Win32.Build.0 = Release|Win32 + {9F813EB4-8F43-4E58-8C62-8E43D9AC137D}.Debug|Win32.ActiveCfg = Debug|Win32 + {9F813EB4-8F43-4E58-8C62-8E43D9AC137D}.Debug|Win32.Build.0 = Debug|Win32 + {9F813EB4-8F43-4E58-8C62-8E43D9AC137D}.Release|Win32.ActiveCfg = Release|Win32 + {9F813EB4-8F43-4E58-8C62-8E43D9AC137D}.Release|Win32.Build.0 = Release|Win32 + {9CC505F9-AE58-4827-8921-A59E7C4839FE}.Debug|Win32.ActiveCfg = Debug|Win32 + {9CC505F9-AE58-4827-8921-A59E7C4839FE}.Debug|Win32.Build.0 = Debug|Win32 + {9CC505F9-AE58-4827-8921-A59E7C4839FE}.Release|Win32.ActiveCfg = Release|Win32 + {9CC505F9-AE58-4827-8921-A59E7C4839FE}.Release|Win32.Build.0 = Release|Win32 + {ADB1806A-745E-4DB4-9CDC-51658A5061E1}.Debug|Win32.ActiveCfg = Debug|Win32 + {ADB1806A-745E-4DB4-9CDC-51658A5061E1}.Debug|Win32.Build.0 = Debug|Win32 + {ADB1806A-745E-4DB4-9CDC-51658A5061E1}.Release|Win32.ActiveCfg = Release|Win32 + {ADB1806A-745E-4DB4-9CDC-51658A5061E1}.Release|Win32.Build.0 = Release|Win32 + {BB0A837B-DAEF-4B3F-AF5B-9A757A97FFF3}.Debug|Win32.ActiveCfg = Debug|Win32 + {BB0A837B-DAEF-4B3F-AF5B-9A757A97FFF3}.Debug|Win32.Build.0 = Debug|Win32 + {BB0A837B-DAEF-4B3F-AF5B-9A757A97FFF3}.Release|Win32.ActiveCfg = Release|Win32 + {BB0A837B-DAEF-4B3F-AF5B-9A757A97FFF3}.Release|Win32.Build.0 = Release|Win32 + {77907F3D-BA6E-4A7F-AF9D-4F60C0A79952}.Debug|Win32.ActiveCfg = Debug|Win32 + {77907F3D-BA6E-4A7F-AF9D-4F60C0A79952}.Debug|Win32.Build.0 = Debug|Win32 + {77907F3D-BA6E-4A7F-AF9D-4F60C0A79952}.Release|Win32.ActiveCfg = Release|Win32 + {77907F3D-BA6E-4A7F-AF9D-4F60C0A79952}.Release|Win32.Build.0 = Release|Win32 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/win32/libnfc.vcproj b/win32/libnfc.vcproj new file mode 100644 index 0000000..794e977 --- /dev/null +++ b/win32/libnfc.vcproj @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32/list.vcproj b/win32/list.vcproj new file mode 100644 index 0000000..d329b0a --- /dev/null +++ b/win32/list.vcproj @@ -0,0 +1,181 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32/mfread.vcproj b/win32/mfread.vcproj new file mode 100644 index 0000000..4db8719 --- /dev/null +++ b/win32/mfread.vcproj @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32/mfwrite.vcproj b/win32/mfwrite.vcproj new file mode 100644 index 0000000..2e03987 --- /dev/null +++ b/win32/mfwrite.vcproj @@ -0,0 +1,185 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32/relay.vcproj b/win32/relay.vcproj new file mode 100644 index 0000000..1fe3862 --- /dev/null +++ b/win32/relay.vcproj @@ -0,0 +1,182 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32/simulate.vcproj b/win32/simulate.vcproj new file mode 100644 index 0000000..3fc22a2 --- /dev/null +++ b/win32/simulate.vcproj @@ -0,0 +1,182 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/win32bin/anticol.exe b/win32bin/anticol.exe new file mode 100644 index 0000000..fb99f18 Binary files /dev/null and b/win32bin/anticol.exe differ diff --git a/win32bin/libnfc.dll b/win32bin/libnfc.dll new file mode 100644 index 0000000..d0cd5bf Binary files /dev/null and b/win32bin/libnfc.dll differ diff --git a/win32bin/libnfc.lib b/win32bin/libnfc.lib new file mode 100644 index 0000000..060ad6d Binary files /dev/null and b/win32bin/libnfc.lib differ diff --git a/win32bin/list.exe b/win32bin/list.exe new file mode 100644 index 0000000..db52faf Binary files /dev/null and b/win32bin/list.exe differ diff --git a/win32bin/mfread.exe b/win32bin/mfread.exe new file mode 100644 index 0000000..ba3331a Binary files /dev/null and b/win32bin/mfread.exe differ diff --git a/win32bin/mfwrite.exe b/win32bin/mfwrite.exe new file mode 100644 index 0000000..12f3145 Binary files /dev/null and b/win32bin/mfwrite.exe differ diff --git a/win32bin/relay.exe b/win32bin/relay.exe new file mode 100644 index 0000000..7f1050f Binary files /dev/null and b/win32bin/relay.exe differ diff --git a/win32bin/simulate.exe b/win32bin/simulate.exe new file mode 100644 index 0000000..5eef268 Binary files /dev/null and b/win32bin/simulate.exe differ