├── .gitignore ├── LICENSE ├── README.old ├── README.rst ├── src ├── html.py ├── sql.py ├── validate.py ├── yubiserve.py └── yubistatus.py └── tools ├── dbconf.py ├── dbcreate.py ├── flash.py ├── unittests.py └── yubikeyedup.service /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.old: -------------------------------------------------------------------------------- 1 | == Author & Version == 2 | YubiServe has been written by Alessio Periloso 3 | Version 1.0: 21/05/2010 4 | Version 2.0: 19/11/2010 5 | Version 2.9: 13/12/2010 6 | Version 3.0: 14/12/2010 7 | Version 3.1: 24/03/2011 8 | + Fixed issue #3, #4, #5, #6 9 | 10 | == Description == 11 | This simple service allows to authenticate Yubikeys and OATH Tokens using 12 | only a small sqlite database (the mysql support is optional!) 13 | The code has been released under GNU license (license into LICENSE file) 14 | 15 | The project is divided into two parts: 16 | - The database management tool (dbconf.py) 17 | - The validation server (yubiserve.py) 18 | 19 | 20 | == Installation == 21 | Installation is pretty simple, you just have to install few python packages: 22 | 23 | Under Debian, you can run: 24 | apt-get install python python-crypto python-openssl 25 | 26 | Under Mageia, you will need to use: 27 | urpmi python-pycrypto python-OpenSSL 28 | 29 | If you want to add the sqlite support, you should run: 30 | apt-get install python-sqlite 31 | sqlite3 is also supported, which is included with python in RHEL6. 32 | 33 | Or, if you want to add the mysql support, you should run: 34 | apt-get install python-mysqldb 35 | If you chosen the mysql support, you must create a database and create the 36 | tables. The mysql dump is at src/dump.mysql. 37 | 38 | 39 | Then, you have to generate the certificate for ssl validation, so if you don't 40 | already have a certificate you have to issue the following command to self-sign 41 | one: 42 | openssl req -new -x509 -keyout yubiserve.pem -out yubiserve.pem -days 365 -nodes 43 | 44 | A good idea would be taking a look at yubiserve.cfg, to configure the validation server settings. 45 | 46 | After installing the needed packages, you just need to extract the files 47 | to a directory, add the keys and launch the server (or, if you prefer 48 | you can launch the server before adding the keys, it doesn't matter). 49 | 50 | 51 | == The database management tool == 52 | The database management tool helps you to manage keys in the database. 53 | For detailed help, run the database management tool with ./dbconf.py 54 | 55 | The tool allows you to add, delete, disable and enable keys/tokens. 56 | You can also add and remove API keys, to check the server signature in 57 | server responses. 58 | Everything is managed through nicknames, to make keys easy to remember 59 | who belong to. 60 | 61 | For example, to add a new yubikey, write: 62 | ./dbconf.py -ya alessio vvkdtkjureru 980a8608b307 f1dc9c6585d600d06f9aae1abea2969e 63 | 64 | In this example, 'alessio' is the key nickname, 'vvkdtkjureru' is the 65 | key public identity (the one you can see at the beginning of your OTPs), 66 | '980a8608b307' is the private identity of the OTP (you can read it when 67 | you program your key), and the last parameter is the AES Key. 68 | 69 | 70 | To add a new OATH/HOTP: 71 | ./dbconf.py -ha alessio 4rvn24642402 f03ddacdfebb6396f60d7045f41de68f5c5e1c3f 72 | 73 | In this other example, 'alessio' is still the nickname, '4rvn24642402' is 74 | the public identity of the token (it could be also 1, 2, 'alessio' or 75 | whatever you want; the Yubico implementation is 12 characters long) 76 | 77 | 78 | To add a new API key: 79 | ./dbconf.py -aa alessio 80 | 81 | When you add a new API key, the configuration tool will return both 82 | the api key (ex. 'UkxFMnNFNTV4clRYUExSOWlONzQ=') and the API key id 83 | meant to be used later in your queries to the Yubiserve validation server. 84 | 85 | 86 | == The Yubiserve Validation Server == 87 | Understanding how to use the Yubiserve web application is pretty simple. 88 | You just have to run it (./yubiserve.py) and send your queries through 89 | HTTP GET connections. 90 | The default listening port is 8000, the default listening ip is 0.0.0.0 91 | (so you can connect to it from other machines). If you need it to answer 92 | only from local machine, you can change the ip to 127.0.0.1. 93 | The ssl port is by default the next one, so if the http validation server 94 | answers on port 8000, the ssl will answer on port 8001. 95 | Anyway, everything is easily customizable modifying the yubiserve.py file 96 | and changing the variables "yubiservePORT" for the HTTP port, "yubiserveSSLPORT" 97 | for the SSL port, "yubiserveHOST" for the listening ip. 98 | When you connect to the server (ex. http://192.168.0.1:8000/), it will 99 | answer with a simple page, asking you Yubico Yubikeys OTPs or OATH/HOTP 100 | tokens. 101 | The Yubico Yubikey needs only one parameter: the OTP. 102 | The OATH/HOTP tokens needs two parameters: the OTP itself (6 or 8 digits) 103 | and the Token Identifier. The token identifier can be any character string 104 | you prefer, or, according to the standard OATH implementation, the preceding 105 | string to the OTP. The Yubico implementation follows this standard. 106 | The Yubiserve Validation Server, according to the standard, will try to 107 | find the Token Identifier preceding the OTP. If the string is found, the 108 | OTP will be verified according to that string; in case of LCD tokens, 109 | the string is not automatically added, so you will need to insert your ID 110 | in the second box to allow the Validation Server to find your own identity. 111 | 112 | 113 | == Querying the Yubiserve Validation Server == 114 | Querying the Yubiserve Validation Server is pretty simple. 115 | For Yubico Yubikeys, you will need to send a HTTP GET connection to: 116 | http://:/wsapi/2.0/verify?otp= 117 | ex.: http://192.168.0.1:8000/wsapi/2.0/verify?otp=vvnjbbkvjbcnhiretjvjfebbrdgrjjchdhtbderrdbhj 118 | This way you will try to authenticate to it, the simplest way possible. 119 | The response will be something like: 120 | 121 | otp=vvnjbbkvjbcnhiretjvjfebbrdgrjjchdhtbderrdbhj 122 | status=OK 123 | t=2010-11-20T23:54:35 124 | h= 125 | 126 | As you can see, the 'h' parameter is not set, and this is because we didn't use 127 | the signature through API Key. To use it, just add the 'id=' 128 | parameter we had when we added the API Key. 129 | ex.: http://192.168.0.1:8000/wsapi/2.0/verify?otp=vvnjbbkvjbcnhiretjvjfebbrdgrjjchdhtbderrdbhj&id=1 130 | This time the response will be like: 131 | 132 | otp=vvnjbbkvjbcnhiretjvjfebbrdgrjjchdhtbderrdbhj 133 | status=OK 134 | t=2010-11-21T00:00:03 135 | h=6lrhQPKo1I/RQA1KPnjpuiOvVMc= 136 | 137 | To check the server signature, check the source code (you will have to do the 138 | exact same procedure to generate it and then just check if they are equal), or 139 | rely on the Yubico documentation on Validation Servers. 140 | 141 | For OATH/HOTP keys, the query can be simplified or not. 142 | If your token supports the 'Token Identifier', like Yubico Yubikeys, you can just 143 | send one parameter, the generated string, and the Yubiserve Validation Server will 144 | take care of looking for your key informations in the database. 145 | If your token instead only generates the 6-8 digits, you will have to explicit 146 | your publicID through another parameter. 147 | So, you will have to query, via HTTP GET, the following address: 148 | http://:/wsapi/2.0/oathverify?otp=&publicid= 149 | ex.: http://192.168.0.1:8000/wsapi/2.0/oathverify?otp=80l944311056173483 150 | ex.: ex.: http://192.168.0.1:8000/wsapi/2.0/oathverify?otp=173483&publicid=80l944311056 151 | Both the examples works the same way: in the first case, the Token Identifier was 152 | inside the generated OTP (like in Yubico Yubikey implementation), in the second case 153 | an authentication through a LCD Token was made, so the Yubiserve needed to know who 154 | the token belonged to, and the publicid parameter was added. 155 | The response, like Yubico Yubikey queries, is the following: 156 | 157 | otp=80l944311056173483 158 | status=OK 159 | t=2010-11-21T00:04:59 160 | h= 161 | 162 | The 'h' parameter is not set, because we didn't specified the API Key id. To use the 163 | server signature, we will need to add the 'id' parameter, like in the following query: 164 | ex.: http://192.168.1.2:8000/wsapi/2.0/oathverify?otp=80l944311056173483&id=1 165 | ex.: http://192.168.0.1:8000/wsapi/2.0/oathverify?otp=173483&publicid=80l944311056&id=1 166 | 167 | And this would be the the response: 168 | 169 | otp=80l944311056173483 170 | status=OK 171 | t=2010-11-21T00:10:56 172 | h=vYoG9Av8uG6OqVkmMFuANi4fyWw= 173 | 174 | == Basic monitoring of the Yubiserve Validation Server == 175 | 176 | The yubiserve tool allows you to set up basic monitoring by making an http request using 177 | the URI /healthcheck. 178 | 179 | This check will confirm if the yubserve tool is capable of connecting to it's database and 180 | capable of performing queries. It also counts the number of enabled tokens/keys, and will produce 181 | a warning if no keys are enabled. 182 | 183 | Options are: 184 | /healthcheck?service=all 185 | /healthcheck?service=oathtoken 186 | /healthcheck?service=yubikeys 187 | 188 | Example: curl -s http://localhost:8000/healthcheck?service=yubikeys 189 | 190 | Output format is: 191 | OK: (no message) 192 | WARN: multi-line warning message 193 | CRITICAL: multi-line warning message 194 | 195 | HTTP result codes: 196 | 200 - OK / WARN 197 | 404 - Something bad, the health check did not run 198 | 500 - The healthcheck got an un-handled exception during operation. An error will be printed. 199 | 503 - The healthcheck found no enabled keys. 200 | 201 | The recommended way to perform this is to use Nagios or other monitoring tool to poll the yubiserve health check 202 | and check the returned string starts with "OK:" 203 | 204 | 205 | == Final thoughts == 206 | That's all. Pretty simple, huh? 207 | Of course you can add new keys while the server is already running, without needing it 208 | to restart, and of course multiple queries a time are allowed, that's why the server 209 | is multithreaded. 210 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Yet Another YubiKey OTP Validation Server 2 | ========================================= 3 | 4 | Several other implementations are available. Some of them are not secure enough: 5 | 6 | * `YubiServe `_ (Python). `SQL 7 | injections 8 | `_, 9 | * `yubiserver `_ (C). SQL injections 10 | (CVE-2015-0842), buffer overflows (CVE-2015-0843). 11 | 12 | Official implementation is written in PHP (sigh...), and I don't know Go enough 13 | to audit digintLab's implementation: 14 | 15 | * `yubikey-val `_ (PHP) by Yubico, 16 | * `yubikey-server `_ (Go). 17 | 18 | This is a complete rewrite of `YubiServe 19 | `_ because the original project 20 | seems not to be designed with security in mind. Copy-and-paste programming made 21 | code reviews nearly impossible, there is no protection against SQL injection, 22 | etc. 23 | 24 | This fork was given a new name to make it easy for people to differentiate from 25 | the original project. 26 | 27 | 28 | Usage 29 | ===== 30 | 31 | Create a new database:: 32 | 33 | $ ./tools/dbcreate.py ./yubikeys.sqlite3 34 | 35 | Plug and flash the YubiKeys (keys are also written to the database):: 36 | 37 | $ ./tools/flash.py gbush ./yubikeys.sqlite3 38 | $ ./tools/flash.py bobama ./yubikeys.sqlite3 39 | 40 | Add a new API key (here, the API key name is ``developers``):: 41 | 42 | $ ./tools/dbconf.py -aa developers ./yubikeys.sqlite3 43 | 44 | Run the server:: 45 | 46 | $ ./src/yubiserve.py --db ./yubikeys.sqlite3 47 | 48 | That's it. The servers wanting to make use of two factor authentication need to 49 | be configured. The following paragraph shows an example for OpenSSH. 50 | 51 | 52 | OpenSSH configuration example 53 | ============================= 54 | 55 | Here's a summary of `Yubico's documentation 56 | `_. 57 | 58 | Get information about users and API on the machine hosting 59 | ``yubikeys.sqlite3``:: 60 | 61 | $ ./tools/dbconf.py -yl ./yubikeys.sqlite3 62 | 2 keys into database: 63 | [Nickname] >> [PublicID] >> [Active] 64 | gbush >> ibhdhehrhkhuifhv >> 1 65 | bobama >> ibibhdhvhdhbhthb >> 1 66 | 67 | $ ./tools/dbconf.py -al ./yubikeys.sqlite3 68 | 1 keys into database: 69 | [Id] >> [Keyname] >> [Secret] 70 | 1 >> developers >> ckFsWU5scVNXRjVZc3lJUmpIVzU= 71 | 72 | On the OpenSSH machine, add users to ``/etc/yubimap``:: 73 | 74 | $ cat /etc/yubimap 75 | barack:ibibhdhvhdhbhthb 76 | george:ibhdhehrhkhuifhv 77 | 78 | Configure PAM to use YubiKey authentication (take care of API ``id`` and API 79 | ``key`` values):: 80 | 81 | $ head /etc/pam.d/sshd | grep include 82 | #@include common-auth 83 | @include yubi-auth 84 | 85 | $ cat /etc/pam.d/yubi-auth 86 | auth required pam_yubico.so authfile=/etc/yubimap id=1 key=ckFsWU5scVNXRjVZc3lJUmpIVzU= url=http://yubikeyval.local:8000/wsapi/2.0/verify?id=%d&otp=%s mode=client token_id_length=16 87 | 88 | Configure OpenSSH:: 89 | 90 | $ tail -4 /etc/ssh/sshd_config 91 | ChallengeResponseAuthentication no 92 | Match User george,barack 93 | PasswordAuthentication yes 94 | AuthenticationMethods publickey,password 95 | 96 | 97 | TODO 98 | ==== 99 | 100 | OATH/HOTP is not supported at present. 101 | 102 | 103 | Original author 104 | =============== 105 | 106 | * Alessio Periloso 107 | -------------------------------------------------------------------------------- /src/html.py: -------------------------------------------------------------------------------- 1 | index = ''' 2 | 3 | 4 | 11 | 12 | 13 | Yubico Yubikeys:
14 |
15 |

16 |

17 |

18 |

19 |
20 |
21 | 22 | 30 | 31 | 42 | 43 | 44 | ''' 45 | -------------------------------------------------------------------------------- /src/sql.py: -------------------------------------------------------------------------------- 1 | import sqlite3 2 | 3 | 4 | class SQL: 5 | REQUESTS = { 6 | 'yubico_get_key': 'SELECT aeskey, internalname, counter, time FROM yubikeys WHERE publicname = ? AND active = 1', 7 | 'yubico_update_counter': 'UPDATE yubikeys SET counter = ?, time = ? WHERE publicname = ?', 8 | 9 | 'oath_get_token': 'SELECT counter, secret FROM oathtokens WHERE publicname = ? AND active = 1', 10 | 'oath_update_counter': 'UPDATE oathtokens SET counter = ? WHERE publicname = ?', 11 | 12 | 'get_api_secret': 'SELECT secret from apikeys WHERE id = ?', 13 | } 14 | 15 | def __init__(self, con): 16 | self.con = con 17 | self.cur = self.con.cursor() 18 | 19 | def select(self, req, param): 20 | self.cur.execute(self.REQUESTS[req], param) 21 | self.result = self.cur.fetchone() 22 | return self.result != None 23 | 24 | def update(self, req, param): 25 | self.con.execute(self.REQUESTS[req], param) 26 | self.con.commit() 27 | 28 | def connect_to_db(filename): 29 | return sqlite3.connect(filename, check_same_thread=False) 30 | -------------------------------------------------------------------------------- /src/validate.py: -------------------------------------------------------------------------------- 1 | import re 2 | 3 | from Cryptodome.Cipher import AES 4 | 5 | from sql import * 6 | import yubistatus 7 | 8 | 9 | class Validate: 10 | def __init__(self, sql): 11 | self.sql = sql 12 | 13 | 14 | class Yubico(Validate): 15 | # sorry for this one-liner 16 | modhex = ''.join(dict([ ('cbdefghijklnrtuv'[i], '0123456789abcdef'[i]) for i in range(16)] ).get(chr(j), '?') for j in range(256)) 17 | 18 | def set_params(self, params, answer): 19 | if 'nonce' not in params: 20 | return yubistatus.MISSING_PARAMETER 21 | 22 | answer['otp'] = params['otp'] 23 | answer['nonce'] = params['nonce'] 24 | answer['sl'] = '100' 25 | 26 | self.otp = params['otp'] 27 | 28 | return yubistatus.OK 29 | 30 | def modhexdecode(self, string): 31 | return bytes.fromhex(string.translate(self.modhex)) 32 | 33 | def CRC(self, data): 34 | crc = 0xffff 35 | for b in data: 36 | crc ^= (b & 0xff) 37 | for j in range(0, 8): 38 | n = crc & 1 39 | crc >>= 1 40 | if n != 0: 41 | crc ^= 0x8408 42 | return crc 43 | 44 | def validate(self): 45 | match = re.match('([cbdefghijklnrtuv]{0,16})([cbdefghijklnrtuv]{32})', self.otp) 46 | if not match: 47 | # this should not happen because otp matches YubiHTTPServer.PARAM_REGEXP 48 | return yubistatus.BACKEND_ERROR 49 | 50 | userid, token = match.groups() 51 | 52 | if not self.sql.select('yubico_get_key', [userid]): 53 | return yubistatus.BAD_OTP 54 | aeskey, internalname, counter, time = self.sql.result 55 | 56 | aes = AES.new(bytes.fromhex(aeskey), AES.MODE_ECB) 57 | plaintext = aes.decrypt(self.modhexdecode(token)).hex() 58 | 59 | if internalname != plaintext[:12]: 60 | return yubistatus.BAD_OTP 61 | 62 | # if self.CRC(plaintext[:32].decode('hex')) != 0xf0b8: 63 | if self.CRC(bytes.fromhex(plaintext[:32])) != 0xf0b8: 64 | return yubistatus.BAD_OTP 65 | 66 | internalcounter = int(plaintext[14:16] + plaintext[12:14] + plaintext[22:24], 16) 67 | if counter >= internalcounter: 68 | return yubistatus.REPLAYED_OTP 69 | 70 | timestamp = int(plaintext[20:22] + plaintext[18:20] + plaintext[16:18], 16) 71 | if time >= timestamp and (counter >> 8) == (internalcounter >> 8): 72 | return yubistatus.BAD_OTP 73 | 74 | self.sql.update('yubico_update_counter', [internalcounter, timestamp, userid]) 75 | 76 | return yubistatus.OK 77 | 78 | 79 | class OATH(Validate): 80 | def set_params(self, params, answer): 81 | if len(otp) in [ 18, 20 ]: 82 | publicid = otp[0:12] 83 | oath = params['otp'][12:] 84 | elif len(otp) in [ 6, 8 ]: 85 | if 'publicid' not in params: 86 | return yubistatus.MISSING_PARAMETER 87 | publicid = params['publicid'] 88 | oath = params['otp'] 89 | else: 90 | return yubistatus.BAD_OTP 91 | 92 | answer['otp'] = params['otp'] 93 | 94 | self.oath = oath 95 | self.publicid = publicid 96 | 97 | return yubistatus.OK 98 | 99 | def test_hotp(self, key, counter, digits=6): 100 | counter = str(counter).rjust(16, '0').decode('hex') 101 | hs = hmac.new(key, counter, hashlib.sha1).digest() 102 | offset = ord(hs[19]) & 0xF 103 | bin_code = int((chr(ord(hs[offset]) & 0x7F) + hs[offset+1:offset+4]).encode('hex'), 16) 104 | return str(bin_code)[-digits:] 105 | 106 | def validate(self): 107 | # XXX: TODO, it hasn't been tested 108 | return yubistatus.BACKEND_ERROR 109 | 110 | if len(self.oath) % 2 != 0: 111 | return yubistatus.BAD_OTP 112 | 113 | if not self.sql.select('oath_get_token', [publicid]): 114 | return yubistatus.BAD_OTP 115 | 116 | actualcounter, key = self.sql.result 117 | key = key.decode('hex') 118 | for counter in range(actualcounter + 1, actualcounter + 256): 119 | if self.oath == self.test_hotp(key, counter, len(self.oath)): 120 | self.sql.update('yubico_update_counter', [str(counter), self.publicid]) 121 | return yubistatus.OK 122 | 123 | return yubistatus.BAD_OTP 124 | -------------------------------------------------------------------------------- /src/yubiserve.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import http.server 4 | import socketserver 5 | import base64 6 | import hashlib 7 | import hmac 8 | import optparse 9 | import os 10 | import re 11 | import signal 12 | import socket 13 | import sys 14 | import threading 15 | import time 16 | import urllib.request, urllib.parse, urllib.error 17 | import urllib.parse 18 | 19 | import yubistatus 20 | import validate 21 | import html 22 | from sql import * 23 | 24 | 25 | class YubiServeHandler: 26 | def __init__(self, sql_connection, params, vclass): 27 | self.sql = SQL(sql_connection) 28 | self.params = params 29 | self.vclass = vclass 30 | 31 | def sign_message(self, answer, api_key): 32 | data = [ '%s=%s' % (k, v) for (k, v) in answer.items() ] 33 | data.sort() 34 | data = '&'.join(data) 35 | 36 | otp_hmac = hmac.new(api_key, data.encode('utf-8'), hashlib.sha1) 37 | otp_hmac = base64.b64encode(otp_hmac.digest()).decode('utf-8') 38 | 39 | return otp_hmac 40 | 41 | def build_answer(self, status, answer, api_key=bytes()): 42 | answer['status'] = status 43 | answer['h'] = self.sign_message(answer, api_key) 44 | 45 | data = '\r\n'.join([ '%s=%s' % (k, v) for (k, v) in answer.items() ]) 46 | data += '\r\n' 47 | 48 | return data 49 | 50 | def do_validate(self): 51 | answer = { 't': time.strftime("%Y-%m-%dT%H:%M:%S"), 'otp': '' } 52 | 53 | # API id and OTP are required 54 | if 'id' not in self.params or 'otp' not in self.params: 55 | return self.build_answer(yubistatus.MISSING_PARAMETER, answer) 56 | 57 | # ensure API id is valid 58 | if not self.sql.select('get_api_secret', [self.params['id']]): 59 | return self.build_answer(yubistatus.NO_SUCH_CLIENT, answer) 60 | 61 | api_key = base64.b64decode(self.sql.result[0]) 62 | 63 | # do token validation 64 | vclass = self.vclass(self.sql) 65 | status = vclass.set_params(self.params, answer) 66 | if status == yubistatus.OK: 67 | status = vclass.validate() 68 | return self.build_answer(status, answer, api_key) 69 | 70 | 71 | class YubiHTTPServer(http.server.BaseHTTPRequestHandler): 72 | __base = http.server.BaseHTTPRequestHandler 73 | __base_handle = __base.handle 74 | 75 | server_version = 'YubiKeyedUp/1.0' 76 | vclasses = { 77 | '/wsapi/2.0/verify': validate.Yubico, 78 | '/wsapi/2.0/oathverify': validate.OATH, 79 | } 80 | 81 | PARAM_REGEXP = { 82 | 'id': '[0-9]{1,3}', 83 | 'otp': '[cbdefghijklnrtuv]{0,16}[cbdefghijklnrtuv]{32}', 84 | 'publicid': '[cbdefghijklnrtuv]{0,16}', 85 | 'nonce': '[a-zA-Z0-9]{16,40}', 86 | } 87 | 88 | def __init__(self, request, client_address, server): 89 | global sqlite_db 90 | self.sql_connection = connect_to_db(sqlite_db) 91 | return http.server.BaseHTTPRequestHandler.__init__(self, request, client_address, server) 92 | 93 | def setup(self): 94 | self.connection = self.request 95 | self.rfile = self.request.makefile( 'rb', self.rbufsize) 96 | self.wfile = self.request.makefile( 'wb', self.wbufsize) 97 | 98 | def getToDict(self, qs): 99 | dict = {} 100 | for singleValue in qs.split('&'): 101 | if not '=' in singleValue: 102 | continue 103 | key, value = singleValue.split('=', 1) 104 | value = urllib.parse.unquote_plus(value) 105 | if key in self.PARAM_REGEXP and re.match(self.PARAM_REGEXP[key], value): 106 | dict[key] = value 107 | return dict 108 | 109 | def do_GET(self): 110 | url = urllib.parse.urlparse(self.path, 'http') 111 | 112 | if url.path in self.vclasses: 113 | params = self.getToDict(url.query) 114 | vclass = self.vclasses[url.path] 115 | handler = YubiServeHandler(self.sql_connection, params, vclass) 116 | data = handler.do_validate() 117 | content_type = 'text/plain' 118 | else: 119 | data = index = html.index 120 | content_type = 'text/html' 121 | 122 | self.send_response(200) 123 | self.send_header('Content-type', content_type) 124 | self.end_headers() 125 | self.wfile.write(data.encode('utf-8')) 126 | 127 | 128 | class ThreadingHTTPServer(socketserver.ThreadingMixIn, http.server.HTTPServer): 129 | pass 130 | 131 | 132 | def stop_signal_handler(signum, frame): 133 | yubiserveHTTP.shutdown() 134 | sys.exit(0) 135 | 136 | 137 | if __name__ == '__main__': 138 | parser = optparse.OptionParser('Usage: %prog [options]') 139 | parser.add_option('-d', '--db', default='./yubikeys.sqlite3', dest='db') 140 | parser.add_option('-a', '--address', default='0.0.0.0', dest='host') 141 | parser.add_option('-p', '--port', default='8000', dest='port') 142 | (options, args) = parser.parse_args() 143 | sqlite_db = options.db 144 | 145 | yubiserveHTTP = ThreadingHTTPServer((options.host, int(options.port)), YubiHTTPServer) 146 | 147 | signal.signal(signal.SIGINT, stop_signal_handler) 148 | 149 | http_thread = threading.Thread(target=yubiserveHTTP.serve_forever) 150 | http_thread.setDaemon(True) 151 | http_thread.start() 152 | 153 | signal.pause() 154 | -------------------------------------------------------------------------------- /src/yubistatus.py: -------------------------------------------------------------------------------- 1 | OK = 'OK' 2 | BAD_OTP = 'BAD_OTP' 3 | REPLAYED_OTP = 'REPLAYED_OTP' 4 | BAD_SIGNATURE = 'BAD_SIGNATURE' 5 | MISSING_PARAMETER = 'MISSING_PARAMETER' 6 | NO_SUCH_CLIENT = 'NO_SUCH_CLIENT' 7 | OPERATION_NOT_ALLOWED = 'OPERATION_NOT_ALLOWED' 8 | BACKEND_ERROR = 'BACKEND_ERROR' 9 | NOT_ENOUGH_ANSWERS = 'NOT_ENOUGH_ANSWERS' 10 | REPLAYED_REQUEST = 'REPLAYED_REQUEST' 11 | -------------------------------------------------------------------------------- /tools/dbconf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | ''' 4 | YubiServe Key Management Tool 5 | ''' 6 | 7 | import base64 8 | import os 9 | import random 10 | import re 11 | import sqlite3 12 | import sys 13 | import time 14 | 15 | 16 | def randomChars(size): 17 | data = bytes() 18 | with open('/dev/urandom','rb') as fp: 19 | data = fp.read(size) 20 | return data 21 | 22 | 23 | def usage(): 24 | print('Usage: %s \n' % sys.argv[0]) 25 | print(' -ya \tAdd a new Yubikey') 26 | print(' -yk \t\t\t\t\tDelete a Yubikey') 27 | print(' -yd \t\t\t\t\tDisable a Yubikey') 28 | print(' -ye \t\t\t\t\tEnable a Yubikey') 29 | print(' -yl\t\t\t\t\t\tList all yubikeys in database\n') 30 | 31 | print(' -ha \t\tAdd a new OATH token') 32 | print(' -hk \t\t\t\t\tDelete a OATH token') 33 | print(' -hd \t\t\t\t\tDisable a OATH token') 34 | print(' -he \t\t\t\t\tEnable a OATH token') 35 | print(' -hl\t\t\t\t\t\tList all OATH tokens in database\n') 36 | 37 | print(' -aa \t\t\t\t\tGenerate an API Key') 38 | print(' -ak \t\t\t\t\tRemove an API Key') 39 | print(' -al\t\t\t\t\t\tList all API Keys in database') 40 | 41 | sys.exit(0) 42 | 43 | 44 | class DBConf: 45 | REQUESTS = { 46 | 'y_get_active': 'SELECT active FROM yubikeys WHERE nickname = ?', 47 | 'y_set_active': 'UPDATE yubikeys SET active = ? WHERE nickname = ?', 48 | 'y_delete': 'DELETE FROM yubikeys WHERE nickname = ?', 49 | 'y_count_nickname': 'SELECT count(nickname) FROM yubikeys WHERE nickname = ? OR publicname = ?', 50 | 'y_add': 'INSERT INTO yubikeys VALUES (?, ?, ?, ?, ?, 1, 1, 1)', 51 | 52 | 'oath_get_active': 'SELECT active FROM oathtokens WHERE nickname = ?', 53 | 'oath_set_active': 'UPDATE oathtokens SET active = ? WHERE nickname = ?', 54 | 'oath_delete': 'DELETE FROM oathtokens WHERE nickname = ?', 55 | 'oath_count_nickname': 'SELECT count(nickname) FROM oathtokens WHERE nickname = ? OR publicname = ?', 56 | 'oath_add': 'INSERT INTO oathtokens VALUES (?, ?, ?, ?, 1, 1)', 57 | 58 | 'api_count_nickname': 'SELECT count(nickname) FROM apikeys WHERE nickname = ?', 59 | 'api_count_nicknames': 'SELECT count(nickname) FROM apikeys', 60 | 'api_get_last_id': 'SELECT id FROM apikeys ORDER BY id DESC LIMIT 1', 61 | 'api_add': 'INSERT INTO apikeys VALUES (?, ?, ?)', 62 | } 63 | 64 | def __init__(self, filename, verbose=True): 65 | self.con = sqlite3.connect(filename) 66 | self.cur = self.con.cursor() 67 | self.verbose = verbose 68 | 69 | def select(self, req, param): 70 | self.cur.execute(self.REQUESTS[req], param) 71 | self.result = self.cur.fetchone() 72 | return self.result != None 73 | 74 | def update(self, req, param): 75 | self.con.execute(self.REQUESTS[req], param) 76 | self.con.commit() 77 | 78 | def log(self, msg): 79 | if self.verbose: 80 | print(msg) 81 | 82 | 83 | class Yubikey(DBConf): 84 | def add(self, nickname, publicid, secretid, aeskey): 85 | if len(nickname) > 16 or len(publicid) > 16 or len(secretid) > 12 or len(aeskey) > 32: 86 | print('Nickname and publicid must be max 16 characters long.') 87 | print('Secretid must be 12 characters max, aeskey must be 32 characters max.') 88 | return -1 89 | 90 | self.select('y_count_nickname', [nickname, publicid]) 91 | if self.result[0] != 0: 92 | self.log('Key is already into database. Delete it before adding the same key!') 93 | return -1 94 | 95 | t = time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime()) 96 | self.update('y_add', [ nickname, publicid, t, secretid, aeskey ]) 97 | self.log('Key %s added to database.' % nickname) 98 | 99 | def delete(self, nickname): 100 | if not self.select('y_get_active', [ nickname ]): 101 | self.log('Key not found.') 102 | return -1 103 | 104 | self.update('y_delete', [ nickname ]) 105 | self.log('Key %s deleted.' % nickname) 106 | 107 | def disable(self, nickname): 108 | if not self.select('y_get_active', [ nickname ]): 109 | self.log('Key not found.') 110 | return -1 111 | 112 | active = self.result[0] 113 | if not active: 114 | self.log('Key is already disabled.') 115 | return 0 116 | 117 | self.update('y_set_active', [ 0, nickname ]) 118 | self.log('Key %s disabled.' % nickname) 119 | 120 | def enable(self, nickname): 121 | if not self.select('y_get_active', [ nickname ]): 122 | self.log('Key not found.') 123 | return -1 124 | 125 | active = self.result[0] 126 | if active: 127 | self.log('Key is already enabled.') 128 | return 0 129 | 130 | self.update('y_set_active', [ 1, nickname ]) 131 | self.log('Key %s enabled.' % nickname) 132 | 133 | def list(self): 134 | self.cur.execute('SELECT count(nickname) FROM yubikeys') 135 | rowcount = self.cur.fetchone() 136 | self.log('%d keys into database:' % rowcount[0]) 137 | 138 | users = [] 139 | if rowcount[0]: 140 | self.cur.execute('SELECT nickname, publicname, active FROM yubikeys') 141 | self.log('[Nickname]\t\t>> [PublicID]\t\t>> [Active]') 142 | for nickname, publicname, active in self.cur: 143 | self.log('%-23s >> %-20s >> %s ' % (nickname, publicname, active)) 144 | users.append((nickname, publicname, active)) 145 | 146 | return users 147 | 148 | class OATH(DBConf): 149 | def add(self, nickname, publicid, key): 150 | if len(nickname) > 16 or len(publicid) > 16 or len(key) > 40: 151 | print('Nickname and publicid must be max 16 characters long.') 152 | print('Secret key must be 40 characters max.') 153 | return -1 154 | 155 | self.select('oath_count_nickname', [nickname, publicid]) 156 | if self.result[0] != 0: 157 | self.log('Key is already into database. Delete it before adding the same key!') 158 | return -1 159 | 160 | t = time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()) 161 | self.update('INSERT INTO oathtokens VALUES (?, ?, ?, ?, 1, 1)', [nickname, publicid, t, key]) 162 | self.log('Key "%s" added to database.' % key) 163 | 164 | def disable(self, nickname): 165 | if not self.select('oath_get_active', [ nickname ]): 166 | self.log('Key not found.') 167 | return -1 168 | 169 | active = self.result[0] 170 | if not active: 171 | self.log('Key is already disabled.') 172 | return 0 173 | 174 | self.update('oath_set_active', [ 0, nickname ]) 175 | self.log('Key %s disabled.' % nickname) 176 | 177 | def enable(self, nickname): 178 | if not self.select('oath_get_active', [ nickname ]): 179 | self.log('Key not found.') 180 | return -1 181 | 182 | active = self.result[0] 183 | if active: 184 | self.log('Key is already enabled.') 185 | return 0 186 | 187 | self.update('oath_set_active', [ 1, nickname ]) 188 | self.log('Key %s enabled.' % nickname) 189 | 190 | def delete(self, nickname): 191 | if not self.select('oath_get_active', [ nickname ]): 192 | self.log('Key not found.') 193 | return -1 194 | 195 | self.update('y_delete', [ nickname ]) 196 | self.log('Key %s deleted.' % nickname) 197 | 198 | def list(self): 199 | cur.execute('SELECT count(nickname) FROM oathtokens') 200 | rowcount = cur.fetchone() 201 | self.log(" %d keys into database:" % rowcount[0]) 202 | 203 | if rowcount[0] != 0: 204 | cur.execute('SELECT nickname, publicname, active FROM oathtokens') 205 | self.log('[Nickname]\t\t>> [PublicID]') 206 | for (nickname, publicname,active) in cur: 207 | self.log('%-23s >> %-21s >> %s ' % (nickname, publicname, active)) 208 | 209 | class API(DBConf): 210 | def add(self, nickname): 211 | self.select('api_count_nickname', [nickname]) 212 | if self.result[0] != 0: 213 | self.log('API Key for this nickname is already present. Remove it or choose another one.') 214 | return -1 215 | 216 | if not self.select('api_get_last_id', []): 217 | id = 1 218 | else: 219 | lastid = self.result[0] 220 | id = lastid + 1 221 | 222 | api_key = base64.b64encode(randomChars(20)) 223 | self.update('api_add', [nickname, api_key, id]) 224 | self.log('New API Key for %s: %s' % (nickname, api_key)) 225 | self.log('Your API Key ID is: %d' % id) 226 | 227 | def delete(self, nickname): 228 | self.select('api_count_nickname', [nickname]) 229 | if self.result[0] == 0: 230 | self.log("API Key for this nickname doesn't exists!") 231 | return -1 232 | 233 | self.cur.execute('DELETE FROM apikeys WHERE nickname = ?', [nickname]) 234 | self.con.commit() 235 | self.log('API Key for %s has been deleted.' % nickname) 236 | 237 | def list(self): 238 | self.select('api_count_nicknames', []) 239 | rowcount = self.result[0] 240 | self.log('%d keys into database:' % rowcount) 241 | 242 | keys = [] 243 | if rowcount != 0: 244 | self.cur.execute('SELECT id, nickname, secret FROM apikeys') 245 | self.log('[Id]\t>> [Keyname]\t\t>> [Secret]') 246 | for id, nickname, secret in self.cur: 247 | self.log('%-7d >> %-20s >> %s' % (id, nickname, secret)) 248 | keys.append((id, nickname, secret)) 249 | else: 250 | self.log('No keys in database') 251 | return keys 252 | 253 | 254 | if __name__ == '__main__': 255 | options = { 256 | '-ya': (4, Yubikey, 'add'), 257 | '-yk': (1, Yubikey, 'delete'), 258 | '-yd': (1, Yubikey, 'disable'), 259 | '-ye': (1, Yubikey, 'enable'), 260 | '-yl': (0, Yubikey, 'list'), 261 | 262 | '-ha': (3, OATH, 'add'), 263 | '-hk': (1, OATH, 'delete'), 264 | '-hd': (1, OATH, 'disable'), 265 | '-he': (1, OATH, 'enable'), 266 | '-hl': (0, OATH, 'list'), 267 | 268 | '-aa': (1, API, 'add'), 269 | '-ak': (1, API, 'delete'), 270 | '-al': (0, API, 'list'), 271 | } 272 | 273 | argv = sys.argv[1:] 274 | if len(argv) == 0: 275 | usage() 276 | 277 | if argv[0] not in options: 278 | usage() 279 | 280 | n, klass, fname = options[argv[0]] 281 | if len(argv[1:]) != n + 1: 282 | usage() 283 | 284 | filename = argv[-1] 285 | if not os.path.exists(filename): 286 | print('SQLite database "%s" doesn\'t exist' % filename) 287 | sys.exit(1) 288 | 289 | args = argv[1:-1] 290 | function = getattr(klass, fname) 291 | db = klass(filename) 292 | function(db, *args) 293 | -------------------------------------------------------------------------------- /tools/dbcreate.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import os 4 | import sqlite3 5 | import sys 6 | 7 | TABLES = [ 8 | '''yubikeys( 9 | nickname varchar(16) unique not null, 10 | publicname varchar(16) unique not null, 11 | created varchar(24) not null, 12 | internalname varchar(12) not null, 13 | aeskey varchar(32) not null, 14 | active boolean default true, 15 | counter integer not null default 1, 16 | time integer not null default 1 17 | )''', 18 | '''oathtokens( 19 | nickname varchar(16) unique not null, 20 | publicname varchar(12) unique not null, 21 | created varchar(24) not null, 22 | secret varchar(40) not null, 23 | active boolean default true, 24 | counter integer not null default 1 25 | )''', 26 | '''apikeys( 27 | nickname varchar(16), 28 | secret varchar(28), 29 | id integer primary key 30 | )''', 31 | ] 32 | 33 | def create_db(filename): 34 | if os.path.exists(filename): 35 | print('%s already exists' % filename) 36 | sys.exit(1) 37 | 38 | conn = sqlite3.connect(filename) 39 | c = conn.cursor() 40 | for table in TABLES: 41 | c.execute('CREATE TABLE %s' % table) 42 | conn.commit() 43 | conn.close() 44 | 45 | if __name__ == '__main__': 46 | if len(sys.argv) != 2: 47 | print('Usage: %s ' % sys.argv[0]) 48 | sys.exit(0) 49 | 50 | create_db(sys.argv[1]) 51 | -------------------------------------------------------------------------------- /tools/flash.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | ''' 4 | Write a new AES key to a YubiKey, and store it into a sqlite3 database. 5 | ''' 6 | 7 | import distutils.spawn 8 | import os 9 | import sys 10 | import subprocess 11 | 12 | 13 | def hex2modhex(string): 14 | l = [ ('0123456789abcdef'[i], 'cbdefghijklnrtuv'[i]) for i in range(16) ] 15 | modhex = ''.join(dict(l).get(chr(j), '?') for j in range(256)) 16 | return string.translate(modhex) 17 | 18 | def gen_random(size): 19 | with open('/dev/urandom','rb') as fp: 20 | s = fp.read(size) 21 | return s 22 | 23 | def get_public(name): 24 | return name.rjust(8, 'q')[:8] 25 | 26 | if __name__ == '__main__': 27 | if len(sys.argv) != 3: 28 | print('Usage: %s ' % sys.argv[0]) 29 | print('eg: %s bobama db/yubikeys.sqlite3' % sys.argv[0]) 30 | sys.exit(0) 31 | 32 | name = sys.argv[1] 33 | db = sys.argv[2] 34 | aeskey = gen_random(16).hex() 35 | public = get_public(name).encode('utf-8').hex() 36 | public_m = hex2modhex(public) 37 | uid = gen_random(6).hex() 38 | 39 | cmd = [ 'ykpersonalize', 40 | '-1', 41 | '-ofixed=h:%s' % public, 42 | '-ouid=%s' % uid, 43 | '-a%s' % aeskey 44 | ] 45 | 46 | print(cmd) 47 | 48 | # prefer sudo over running this script with root privileges 49 | if os.getuid() != 0: 50 | if not distutils.spawn.find_executable('sudo'): 51 | print('Root privileges required.') 52 | sys.exit(1) 53 | cmd = [ 'sudo' ] + cmd 54 | 55 | try: 56 | ret = subprocess.call(cmd) 57 | except OSError as e: 58 | if e.errno == os.errno.ENOENT: 59 | print('%s: command not found.' % cmd[0]) 60 | sys.exit(1) 61 | else: 62 | raise 63 | 64 | # if ret != 0: 65 | # sys.exit(ret) 66 | 67 | cwd = os.path.dirname(os.path.realpath(__file__)) 68 | dbconf = os.path.join(cwd, 'dbconf.py') 69 | subprocess.call([ dbconf, '-yk', name, db ]) 70 | subprocess.call([ dbconf, '-ya', name, public_m, uid, aeskey, db ]) 71 | subprocess.call([ dbconf, '-yl', db]) 72 | -------------------------------------------------------------------------------- /tools/unittests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import base64 4 | import hashlib 5 | import hmac 6 | import http.client 7 | import os 8 | import re 9 | import subprocess 10 | import time 11 | import unittest 12 | 13 | import dbconf 14 | import dbcreate 15 | 16 | testuser = "nelg" 17 | testserver = "localhost:8001" 18 | yubicotesturl = "/wsapi/2.0/verify" 19 | valid_otp = 'hihrhghufvfibbbekurednelnklnulclbiubvjrenlii' 20 | nonce = 'nILSu3qRwoDldXjgU1' 21 | 22 | 23 | 24 | class YubiserveTestCase(unittest.TestCase): 25 | def setUp(self): 26 | self.tearDown() 27 | return yubikey.add(testuser, 'hihrhghufvfi', '676f6e656c67', '89eb6d3d930077b427a88760db0fc375') 28 | 29 | def tearDown(self): 30 | return yubikey.delete(testuser) 31 | 32 | 33 | class YubikeyTestCase(YubiserveTestCase): 34 | def testDbAPIkey(self): 35 | apikeys = api.list() 36 | self.assertTrue(len(apikeys) > 0, msg="No API keys in DB") 37 | 38 | def testDbconf(self): 39 | users = yubikey.list() 40 | nicknames = [ (nickname, publicid) for nickname, publicid, _ in users ] 41 | self.assertTrue((testuser, 'hihrhghufvfi') in nicknames) 42 | 43 | def testDisableEnableKey(self): 44 | yubikey.disable(testuser) 45 | data = self.curl('?id=1&otp=%s&nonce=%s' % (valid_otp, nonce)) 46 | m = re.search("^status=BAD_OTP", data, re.M) 47 | self.assertTrue(m, msg="Valid yubikey, but account is disabled") 48 | 49 | yubikey.enable(testuser) 50 | data = self.curl('?id=1&otp=%s&nonce=%s' % (valid_otp, nonce)) 51 | m = re.search("^status=OK", data, re.M) 52 | self.assertTrue(m, msg="Valid yubikey not accepted") 53 | 54 | def testSignature(self): 55 | data = self.curl('?id=1&otp=%s&nonce=%s' % (valid_otp, nonce)) 56 | m = re.search("^status=OK", data, re.M) 57 | self.assertTrue(m, msg="Valid yubikey not accepted") 58 | 59 | h = re.findall('h=([^\r]+)', data) 60 | self.assertTrue(len(h) == 1, msg="Invalid hash") 61 | h = h[0] 62 | 63 | data = data.split('\r\n') 64 | data.sort() 65 | data = '&'.join(l for l in data if not l.startswith('h=') and l != '') 66 | _, _, api_key = [ keys for keys in api.list() if keys[1] == 'test' ][0] 67 | otp_hmac = hmac.new(base64.b64decode(api_key), data.encode('utf-8'), hashlib.sha1) 68 | otp_hmac = base64.b64encode(otp_hmac.digest()).decode('utf-8') 69 | self.assertTrue(otp_hmac == h, msg="Invalid signature") 70 | 71 | def testReplayKey(self): 72 | data = self.curl('?id=1&otp=%s&nonce=%s' % (valid_otp, nonce)) 73 | m = re.search("^status=OK", data, re.M) 74 | self.assertTrue(m, msg="Valid yubikey not accepted") 75 | 76 | data = self.curl('?id=1&otp=%s&nonce=%s' % (valid_otp, nonce)) 77 | m = re.search("^status=REPLAYED_OTP", data, re.M) 78 | self.assertTrue(m, msg="Replayed token should not be accepted") 79 | 80 | def testbadCRC(self): 81 | invalid_otp = 'hihrhghufvfirvbegrijgdjhjhtgihcehehtcrgbrhrb' 82 | data = self.curl('?id=1&otp=%s&nonce=%s' % (invalid_otp, nonce)) 83 | m = re.search("^status=BAD_OTP", data, re.M) 84 | self.assertTrue(m, msg="Yubikey with Bad CRC") 85 | 86 | def testInvalidInput(self): 87 | data = self.curl('?id=1&otp=&&&&&&&&&&&&&&&&&&&&&&&&') 88 | m = re.search("^status=MISSING_PARAMETER", data, re.M) 89 | self.assertTrue(m, msg="invalid input should not be accepted, otp not set") 90 | 91 | def testInvalidOTP(self): 92 | invalid_otp = 'hihrhghufvfibbbek1urednelnklnulclbiubvjrenlii' 93 | data = self.curl('?id=1&otp=%s&nonce=%s' % (invalid_otp, nonce)) 94 | m = re.search("^status=MISSING_PARAMETER", data, re.M) 95 | self.assertTrue(m, msg="invalid otp (contains a 1)") 96 | 97 | def testInvalidId(self): 98 | data = self.curl('?id=100&otp=%s&nonce=%s' % (valid_otp, nonce)) 99 | m = re.search("^status=NO_SUCH_CLIENT", data, re.M) 100 | self.assertTrue(m, msg="API id shouldn't be accepted") 101 | 102 | def curl(self, params='?id=1&otp=%s' % valid_otp, debug=False, url=yubicotesturl, httpcode=200): 103 | conn = http.client.HTTPConnection(testserver) 104 | conn.request('GET', url + params) 105 | r = conn.getresponse() 106 | self.assertTrue(r.status == httpcode) 107 | data = r.read().decode('utf-8') 108 | conn.close() 109 | if debug: 110 | print('Request: %s\n' % (url+params)) 111 | print(data) 112 | return data 113 | 114 | 115 | def wait_for_server(testserver=testserver): 116 | while True: 117 | try: 118 | conn = http.client.HTTPConnection(testserver) 119 | conn.request('GET', "/") 120 | conn.close() 121 | return 122 | except IOError: 123 | time.sleep(0.1) 124 | 125 | 126 | if __name__ == '__main__': 127 | filename = '/tmp/yubiservetest.sqlite3' 128 | 129 | try: 130 | os.unlink(filename) 131 | except OSError: 132 | pass 133 | 134 | # create database 135 | dbcreate.create_db(filename) 136 | 137 | # add an API key 138 | api = dbconf.API(filename, verbose=False) 139 | api.add('test') 140 | 141 | yubikey = dbconf.Yubikey(filename, verbose=False) 142 | 143 | p = subprocess.Popen([ './src/yubiserve.py', '--db', filename, '--port=8001' ], stderr=open('/dev/null', 'w')) 144 | wait_for_server() 145 | 146 | try: 147 | suite = unittest.TestLoader().loadTestsFromTestCase(YubikeyTestCase) 148 | unittest.TextTestRunner().run(suite) 149 | finally: 150 | api.delete('test') 151 | os.unlink(filename) 152 | 153 | p.kill() 154 | -------------------------------------------------------------------------------- /tools/yubikeyedup.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Yubikey Validation Server (python3 tidy version) 3 | After=network.target 4 | StartLimitIntervalSec=0 5 | 6 | [Service] 7 | Type=simple 8 | Restart=on-failure 9 | RestartSec=1 10 | User=yubikeyval 11 | ExecStart=/usr/bin/env python3 /home/yubikeyval/yubikeyedup-python3/src/yubiserve.py --db=/home/yubikeyval/yubikeyedup-python3/yubikeys.sqlite3 --address=172.20.241.251 --port=8000 12 | StandardOutput=journal 13 | StandardError=inherit 14 | 15 | 16 | [Install] 17 | WantedBy=multi-user.target 18 | 19 | --------------------------------------------------------------------------------