├── LICENSE ├── README.md ├── bwmenu ├── default.nix ├── flake.lock ├── flake.nix ├── img ├── screenshot1.png └── screenshot2.png └── lib-bwmenu /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.md: -------------------------------------------------------------------------------- 1 | # Bitwarden dmenu Menu 2 | 3 | This is a fork of `bitwarden-rofi` project. 4 | 5 | The first idea is to provide selector-agnostic solution for those who want to use 6 | bitwarden with other dmenu-compatible applications, like wofi or dmenu itself. 7 | 8 | The second one is to allow user to copy not only user/password/totp fields, but 9 | also any custom field. 10 | 11 | On selecting an entry, next dmenu with field names is showing up. 12 | On selecting a field, it is copied to your clipboard for 5 seconds. 13 | During those 5 seconds, a notification is shown indicating which field you 14 | are copying at that time. 15 | 16 | ![bitwarden-rofi](img/screenshot1.png) 17 | 18 | ## Usage 19 | 20 | You can either execute the script from a terminal or by binding it to a key 21 | combination in your window manager. 22 | 23 | For more info please user `--help` flag with `bwmenu` 24 | 25 | ## Extra features 26 | 27 | Instead of hotkeys this fork provides flag based UX to get rid of Rofi 28 | "vendor-lock". There is extra flags `-u -p -t` to copy username, password or 29 | totp. If you provide one of this flags the second menu will not showed up and 30 | selected field will be copied instead. 31 | 32 | ### Custom notification icon 33 | 34 | You can use `-i` flag to provide custom icon for notifications. F.e. `bwmenu -i ~/.local/share/icons/Qogir/scalable/apps/bitwarden.svg` 35 | 36 | ![bitwarden-rofi-notification](img/screenshot2.png) 37 | 38 | ## Install 39 | 40 | ### Via Nix package manager 41 | 42 | Import it as flake and use default application in your application's list. 43 | 44 | ### Via source 45 | 46 | Install these **required** dependencies: 47 | 48 | - rofi/wofi/dmenu or whatever you want 49 | - bitwarden-cli 50 | - jq 51 | 52 | > **Gentoo Users**: It appears Gentoo and some other systems does not provide a kernel with `keyctl`. If so, make sure to install this as well 53 | 54 | **Optionally** install these requirements: 55 | 56 | - xclip, xsel, or wl-clipboard 57 | - xdotool or ydotool 58 | - libnotify to display notifications via `notify-send` 59 | 60 | Then download the script file and place it somewhere on your `$PATH` and grant it 61 | the `+x` permission. 62 | 63 | ```bash 64 | # Install for all users 65 | sudo install -D --mode=755 --group=root --owner=root bwmenu /usr/local/bin/bwmenu 66 | 67 | # Install for yourself 68 | mkdir -p ~/.local/bin && \ 69 | cp bwmenu ~/.local/bin/bwmenu && \ 70 | chmod +x ~/.local/bin/bwmenu 71 | ``` 72 | 73 | ## Hall of Fame 74 | 75 | [![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/0)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/0)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/1)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/1)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/2)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/2)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/3)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/3)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/4)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/4)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/5)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/5)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/6)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/6)[![](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/images/7)](https://sourcerer.io/fame/mattydebie/mattydebie/bitwarden-rofi/links/7) 76 | 77 | ## License 78 | 79 | Released under the GNU General Public License, version 3. See `LICENSE` file. 80 | 81 | Copyright © 2018-2021 82 | 83 | - Anton Plotnikov 84 | - Andreas Backx 85 | - Daniel Prado 86 | - Jonathan Raphaelson. 87 | - Magnus Bergmark 88 | - Matthias De Bie 89 | - Remy Rojas 90 | - Baptiste Pierrat 91 | - Nathan Wallace 92 | - Anton Plotnikov 93 | -------------------------------------------------------------------------------- /bwmenu: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Wofi extension for BitWarden-cli 3 | NAME="$(basename "$0")" 4 | VERSION="0.4" 5 | DEFAULT_CLEAR=5 6 | BW_HASH= 7 | 8 | # Options 9 | CLEAR=$DEFAULT_CLEAR # Clear password after N seconds (0 to disable) 10 | SHOW_PASSWORD=no # Show part of the password in the notification 11 | AUTO_LOCK=900 # 15 minutes, default for bitwarden apps 12 | 13 | # Holds the available items in memory 14 | ITEMS= 15 | 16 | # Stores which command will be used to emulate keyboard type 17 | AUTOTYPE_MODE= 18 | 19 | # Stores which command will be used to deal with clipboards 20 | CLIPBOARD_MODE= 21 | 22 | # Specify what happens when pressing Enter on an item. 23 | # Defaults to copy_password, can be changed to (auto_type all) or (auto_type password) 24 | # ENTER_CMD=copy_password 25 | ENTER_CMD=select_field 26 | 27 | # Item type classification 28 | TYPE_LOGIN=1 29 | TYPE_NOTE=2 30 | TYPE_CARD=3 31 | TYPE_IDENTITY=4 32 | 33 | # Populated in parse_cli_arguments 34 | WOFI_OPTIONS=() 35 | DEDUP_MARK="(+)" 36 | 37 | ASK_PASSWORD_COMMAND="wofi --dmenu -p \"Master Password\" --password --lines 1" 38 | SEARCH_COMMAND="wofi --dmenu -p Name -i" 39 | 40 | ASK_PASSWORD_COMMAND_ROFI="rofi -dmenu -p \"Master Password\" -password -lines 0" 41 | SEARCH_COMMAND_ROFI="rofi -dmenu -p Name -i -no-custom" 42 | 43 | ICON="/usr/share/icons/hicolor/64x64/apps/bitwarden.png" 44 | 45 | # Source helper functions 46 | SCRIPT=$(realpath $0) 47 | DIR="$(dirname "$(readlink -f "$0")")" 48 | source "$DIR/lib-bwmenu" 49 | 50 | ask_password() { 51 | mpw=$(printf '' | eval "$ASK_PASSWORD_COMMAND") || exit $? 52 | echo "$mpw" | bw unlock 2>/dev/null | grep 'export' | sed -E 's/.*export BW_SESSION="(.*==)"$/\1/' || exit_error $? "Could not unlock vault" 53 | } 54 | 55 | get_session_key() { 56 | if [ $AUTO_LOCK -eq 0 ]; then 57 | keyctl purge user bw_session &>/dev/null 58 | BW_HASH=$(ask_password) 59 | else 60 | if ! key_id=$(keyctl request user bw_session 2>/dev/null); then 61 | session=$(ask_password) 62 | [[ -z "$session" ]] && exit_error 1 "Could not unlock vault" 63 | key_id=$(echo "$session" | keyctl padd user bw_session @u) 64 | fi 65 | 66 | if [ $AUTO_LOCK -gt 0 ]; then 67 | keyctl timeout "$key_id" $AUTO_LOCK 68 | fi 69 | BW_HASH=$(keyctl pipe "$key_id") 70 | fi 71 | } 72 | 73 | # source the hash file to gain access to the BitWarden CLI 74 | # Pre fetch all the items 75 | load_items() { 76 | if ! ITEMS=$(bw list items --session "$BW_HASH" 2>/dev/null); then 77 | exit_error $? "Could not load items" 78 | fi 79 | } 80 | 81 | exit_error() { 82 | local code="$1" 83 | local message="$2" 84 | 85 | notify-send "Bwmenu error occurred" "$message" -i "$ICON" 86 | 87 | exit "$code" 88 | } 89 | 90 | # Show the menu with options 91 | # Reads items from stdin 92 | menu() { 93 | eval "$SEARCH_COMMAND" 94 | } 95 | 96 | # Show items in a wofi menu by name of the item 97 | show_items() { 98 | if item=$( 99 | echo "$ITEMS" | 100 | jq -r ".[] | select( has( \"login\" ) ) | \"\\(.name)\"" | 101 | dedup_lines | 102 | menu 103 | ); then 104 | item_array="$(array_from_name "$item")" 105 | "${ENTER_CMD[@]}" "$item_array" 106 | else 107 | wofi_exit_code=$? 108 | item_array="$(array_from_name "$item")" 109 | fi 110 | } 111 | 112 | # Similar to show_items() but using the item's ID for deduplication 113 | show_full_items() { 114 | if item=$( 115 | echo "$ITEMS" | 116 | jq -r ".[] | select( has( \"login\" )) | \"\\(.id): name: \\(.name), username: \\(.login.username)\"" | 117 | menu 118 | ); then 119 | item_id="$(echo "$item" | cut -d ':' -f 1)" 120 | item_array="$(array_from_id "$item_id")" 121 | "${ENTER_CMD[@]}" "$item_array" 122 | else 123 | wofi_exit_code=$? 124 | item_id="$(echo "$item" | cut -d ':' -f 1)" 125 | item_array="$(array_from_id "$item_id")" 126 | fi 127 | } 128 | 129 | # Show items in a wofi menu by url of the item 130 | # if url occurs in multiple items, show the menu again with those items only 131 | show_urls() { 132 | if url=$( 133 | echo "$ITEMS" | 134 | jq -r '.[] | select(has("login")) | .login | select(has("uris")).uris | .[].uri' | 135 | menu 136 | ); then 137 | item_array="$(bw list items --url "$url" --session "$BW_HASH")" 138 | "${ENTER_CMD[@]}" "$item_array" 139 | else 140 | wofi_exit_code="$?" 141 | item_array="$(bw list items --url "$url" --session "$BW_HASH")" 142 | fi 143 | } 144 | 145 | show_folders() { 146 | folders=$(bw list folders --session "$BW_HASH") 147 | if folder=$(echo "$folders" | jq -r '.[] | .name' | menu); then 148 | 149 | folder_id=$(echo "$folders" | jq -r ".[] | select(.name == \"$folder\").id") 150 | 151 | ITEMS=$(bw list items --folderid "$folder_id" --session "$BW_HASH") 152 | show_items 153 | else 154 | wofi_exit_code="$?" 155 | folder_id=$(echo "$folders" | jq -r ".[] | select(.name == \"$folder\").id") 156 | item_array=$(bw list items --folderid "$folder_id" --session "$BW_HASH") 157 | fi 158 | } 159 | 160 | # re-sync the BitWarden items with the server 161 | sync_bitwarden() { 162 | bw sync --session "$BW_HASH" &>/dev/null || exit_error 1 "Failed to sync bitwarden" 163 | 164 | load_items 165 | show_items 166 | } 167 | 168 | # Auto type using xdotool/ydotool 169 | # $1: what to type; all, username, password 170 | # $2: item array 171 | auto_type() { 172 | if not_unique "$2"; then 173 | ITEMS="$2" 174 | show_full_items 175 | else 176 | sleep 0.3 177 | case "$1" in 178 | all) 179 | type_word "$(echo "$2" | jq -r '.[0].login.username')" 180 | type_tab 181 | type_word "$(echo "$2" | jq -r '.[0].login.password')" 182 | ;; 183 | username) 184 | type_word "$(echo "$2" | jq -r '.[0].login.username')" 185 | ;; 186 | password) 187 | type_word "$(echo "$2" | jq -r '.[0].login.password')" 188 | ;; 189 | esac 190 | fi 191 | 192 | } 193 | 194 | # Set $AUTOTYPE_MODE to a command that will emulate keyboard input 195 | select_autotype_command() { 196 | if [[ -z "$AUTOTYPE_MODE" ]]; then 197 | if [ "$XDG_SESSION_TYPE" = "wayland" ] && hash ydotool 2>/dev/null; then 198 | AUTOTYPE_MODE=(sudo ydotool) 199 | elif [ "$XDG_SESSION_TYPE" != "wayland" ] && hash xdotool 2>/dev/null; then 200 | AUTOTYPE_MODE=xdotool 201 | fi 202 | fi 203 | } 204 | 205 | type_word() { 206 | "${AUTOTYPE_MODE[@]}" type "$1" 207 | } 208 | 209 | type_tab() { 210 | "${AUTOTYPE_MODE[@]}" key Tab 211 | } 212 | 213 | # Set $CLIPBOARD_MODE to a command that will put stdin into the clipboard. 214 | select_copy_command() { 215 | if [[ -z "$CLIPBOARD_MODE" ]]; then 216 | if [ "$XDG_SESSION_TYPE" = "wayland" ]; then 217 | hash wl-copy 2>/dev/null && CLIPBOARD_MODE=wayland 218 | elif hash xclip 2>/dev/null; then 219 | CLIPBOARD_MODE=xclip 220 | elif hash xsel 2>/dev/null; then 221 | CLIPBOARD_MODE=xsel 222 | fi 223 | [ -z "$CLIPBOARD_MODE" ] && exit_error 1 "No clipboard command found. Please install either xclip, xsel, or wl-clipboard." 224 | fi 225 | } 226 | 227 | clipboard-set() { 228 | clipboard-${CLIPBOARD_MODE}-set 229 | } 230 | 231 | clipboard-get() { 232 | clipboard-${CLIPBOARD_MODE}-get 233 | } 234 | 235 | clipboard-clear() { 236 | clipboard-${CLIPBOARD_MODE}-clear 237 | } 238 | 239 | clipboard-xclip-set() { 240 | xclip -selection clipboard -r 241 | } 242 | 243 | clipboard-xclip-get() { 244 | xclip -selection clipboard -o 245 | } 246 | 247 | clipboard-xclip-clear() { 248 | echo -n "" | xclip -selection clipboard -r 249 | } 250 | 251 | clipboard-xsel-set() { 252 | xsel --clipboard --input 253 | } 254 | 255 | clipboard-xsel-get() { 256 | xsel --clipboard 257 | } 258 | 259 | clipboard-xsel-clear() { 260 | xsel --clipboard --delete 261 | } 262 | 263 | clipboard-wayland-set() { 264 | wl-copy 265 | } 266 | 267 | clipboard-wayland-get() { 268 | wl-paste 269 | } 270 | 271 | clipboard-wayland-clear() { 272 | wl-copy --clear 273 | } 274 | 275 | # Copy the password 276 | # copy to clipboard and give the user feedback that the password is copied 277 | # $1: json array of items 278 | copy_password() { 279 | if not_unique "$1"; then 280 | ITEMS="$1" 281 | show_full_items 282 | else 283 | pass="$(echo "$1" | jq -r '.[0].login.password')" 284 | 285 | show_copy_notification "$(echo "$1" | jq -r '.[0]')" "Password" 286 | echo -n "$pass" | clipboard-set 287 | 288 | if [[ $CLEAR -gt 0 ]]; then 289 | sleep "$CLEAR" 290 | if [[ "$(clipboard-get)" == "$pass" ]]; then 291 | clipboard-clear 292 | fi 293 | fi 294 | fi 295 | } 296 | 297 | # Copy the password 298 | # copy to clipboard and give the user feedback that the password is copied 299 | # $1: json array of items 300 | copy_username() { 301 | if not_unique "$1"; then 302 | ITEMS="$1" 303 | show_full_items 304 | else 305 | pass="$(echo "$1" | jq -r '.[0].login.username')" 306 | 307 | show_copy_notification "$(echo "$1" | jq -r '.[0]')" "Username" 308 | echo -n "$pass" | clipboard-set 309 | 310 | if [[ $CLEAR -gt 0 ]]; then 311 | sleep "$CLEAR" 312 | if [[ "$(clipboard-get)" == "$pass" ]]; then 313 | clipboard-clear 314 | fi 315 | fi 316 | fi 317 | } 318 | 319 | # Copy the selected field 320 | # copy to clipboard and give the user feedback that the selected field is copied 321 | # $1: json array of items 322 | select_field() { 323 | extra_fields="" 324 | totp="$(echo $1 | jq -r '.[0].login.totp')" 325 | username="$(echo $1 | jq -r '.[0].login.username')" 326 | password="$(echo $1 | jq -r '.[0].login.password')" 327 | 328 | if [[ $totp != "null" ]]; then 329 | extra_fields="TOTP\n$extra_fields" 330 | fi 331 | if [[ $username != "null" ]]; then 332 | extra_fields="Username\n$extra_fields" 333 | fi 334 | if [[ $password != "null" ]]; then 335 | extra_fields="Password\n$extra_fields" 336 | fi 337 | 338 | if not_unique "$1"; then 339 | ITEMS="$1" 340 | show_full_items 341 | else 342 | 343 | if item=$( 344 | printf "$extra_fields$(echo "$1" | jq -r '.[0].fields | .[] .name')" | 345 | menu 346 | ); then 347 | copy_field "$1" "$item" 348 | fi 349 | fi 350 | } 351 | 352 | copy_field() { 353 | if [[ "$2" == "Password" ]]; then 354 | copy_password "$1" 355 | return 356 | elif [[ "$2" == "Username" ]]; then 357 | copy_username "$1" 358 | return 359 | elif [[ "$2" == "TOTP" ]]; then 360 | copy_totp "$1" 361 | return 362 | fi 363 | 364 | # er_id=$(echo "$folders" | jq -r ".[] | select(.name == \"$folder\").id") 365 | field=$(echo "$1" | jq -r ".[0].fields | .[] | select(.name==\"$2\").value") 366 | echo $2 367 | 368 | show_copy_notification "$(echo "$1" | jq -r '.[0]')" "$2" 369 | echo -n "$field" | clipboard-set 370 | 371 | if [[ $CLEAR -gt 0 ]]; then 372 | sleep "$CLEAR" 373 | if [[ "$(clipboard-get)" == "$pass" ]]; then 374 | clipboard-clear 375 | fi 376 | fi 377 | } 378 | 379 | # Copy the TOTP 380 | # $1: item array 381 | copy_totp() { 382 | if not_unique "$1"; then 383 | ITEMS="$item_array" 384 | show_full_items 385 | else 386 | id=$(echo "$1" | jq -r ".[0].id") 387 | 388 | if ! totp=$(bw --session "$BW_HASH" get totp "$id"); then 389 | exit_error 1 "$totp" 390 | fi 391 | 392 | show_copy_notification "$(echo "$1" | jq -r '.[0]')" "TOTP" 393 | echo -n "$totp" | clipboard-set 394 | 395 | if [[ $CLEAR -gt 0 ]]; then 396 | sleep "$CLEAR" 397 | if [[ "$(clipboard-get)" == "$pass" ]]; then 398 | clipboard-clear 399 | fi 400 | fi 401 | 402 | fi 403 | } 404 | 405 | # Lock the vault by purging the key used to store the session hash 406 | lock_vault() { 407 | keyctl purge user bw_session &>/dev/null 408 | } 409 | 410 | # Show notification about the password being copied. 411 | # $1: json item 412 | show_copy_notification() { 413 | local title 414 | local body="" 415 | local extra_options=() 416 | 417 | title="${2} for $(echo "$1" | jq -r '.name') copied" 418 | 419 | if [[ $SHOW_PASSWORD == "yes" ]]; then 420 | pass=$(echo "$1" | jq -r '.login.password') 421 | body="${pass:0:4}****" 422 | fi 423 | 424 | if [[ $CLEAR -gt 0 ]]; then 425 | body="$body\nWill be cleared in ${CLEAR} seconds." 426 | # Keep notification visible while the clipboard contents are active. 427 | extra_options+=("-t" "$((CLEAR * 1000))") 428 | fi 429 | # not sure if icon will be present everywhere, /usr/share/icons is default icon location 430 | notify-send "$title" "$body" "${extra_options[@]}" -i "$ICON" 431 | } 432 | 433 | parse_cli_arguments() { 434 | # Use GNU getopt to parse command line arguments 435 | if ! ARGUMENTS=$(getopt -o c:Cpui: -l icon:,auto-lock:,rofi,ask-password-command:,error-command:,search-command:,clear:,no-clear,show-password,password,user,help,version -- "$@"); then 436 | exit_error 1 "Failed to parse command-line arguments" 437 | fi 438 | eval set -- "$ARGUMENTS" 439 | 440 | while true; do 441 | case "$1" in 442 | --help) 443 | cat <<-USAGE 444 | $NAME $VERSION 445 | 446 | Usage: 447 | $NAME [options] -- [wofi options] 448 | 449 | Options: 450 | --help 451 | Show this help text and exit. 452 | 453 | --version 454 | Show version information and exit. 455 | 456 | --auto-lock 457 | Automatically lock the Vault seconds after last unlock. 458 | Use 0 to lock immediatly. 459 | Use -1 to disable. 460 | Default: 900 (15 minutes) 461 | 462 | -c , --clear 463 | Clear password from clipboard after this many seconds. 464 | Defaults: ${DEFAULT_CLEAR} seconds. 465 | 466 | -C, --no-clear 467 | Don't automatically clear the password from the clipboard. This disables 468 | the default --clear option. 469 | 470 | --show-password 471 | Show the first 4 characters of the copied password in the notification. 472 | 473 | -p, --password 474 | Work with password field. 475 | 476 | -u, --user 477 | Work with username field. 478 | 479 | --ask-password-command 480 | Ask pasword command. By default it is wofi 481 | 482 | --search-command 483 | Search command. By default it is wofi 484 | 485 | --rofi 486 | Use rofi defaults for commands. 487 | Search command: ${SEARCH_COMMAND_COMMAND_ROFI} 488 | Ask password command: ${ASK_PASSWORD_COMMAND_ROFI} 489 | 490 | -i , --icon 491 | Specify path to icon, that will be used for notify-send 492 | 493 | USAGE 494 | shift 495 | exit 0 496 | ;; 497 | --version) 498 | echo "$NAME $VERSION" 499 | shift 500 | exit 0 501 | ;; 502 | --auto-lock) 503 | AUTO_LOCK=$2 504 | shift 2 505 | ;; 506 | -i | --icon) 507 | ICON="$2" 508 | shift 2 509 | ;; 510 | -c | --clear) 511 | CLEAR="$2" 512 | shift 2 513 | ;; 514 | -C | --no-clear) 515 | CLEAR=0 516 | shift 517 | ;; 518 | -p | --password) 519 | ENTER_CMD=copy_password 520 | shift 521 | ;; 522 | -u | --user) 523 | ENTER_CMD=copy_username 524 | shift 525 | ;; 526 | --show-password) 527 | SHOW_PASSWORD=yes 528 | shift 529 | ;; 530 | --rofi) 531 | ASK_PASSWORD_COMMAND="$ASK_PASSWORD_COMMAND_ROFI" 532 | SEARCH_COMMAND="$SEARCH_COMMAND_ROFI" 533 | shift 534 | ;; 535 | --ask-password-command) 536 | ASK_PASSWORD_COMMAND=$2 537 | shift 2 538 | ;; 539 | --search-command) 540 | SEARCH_COMMAND=$2 541 | shift 2 542 | ;; 543 | --) 544 | shift 545 | WOFI_OPTIONS=("$@") 546 | break 547 | ;; 548 | *) 549 | exit_error 1 "Unknown option $1" 550 | ;; 551 | esac 552 | done 553 | } 554 | 555 | parse_cli_arguments "$@" 556 | 557 | get_session_key 558 | select_autotype_command 559 | select_copy_command 560 | load_items 561 | show_items 562 | -------------------------------------------------------------------------------- /default.nix: -------------------------------------------------------------------------------- 1 | { pkgs ? import { } }: 2 | 3 | pkgs.stdenv.mkDerivation { 4 | name = "bwmenu"; 5 | unpackPhase = "true"; 6 | installPhase = '' 7 | mkdir -p $out/bin 8 | cp ${./lib-bwmenu} $out/bin/lib-bwmenu 9 | cp ${./bwmenu} $out/bin/bwmenu 10 | chmod +x $out/bin/bwmenu 11 | ''; 12 | } 13 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "flake-utils": { 4 | "locked": { 5 | "lastModified": 1623875721, 6 | "narHash": "sha256-A8BU7bjS5GirpAUv4QA+QnJ4CceLHkcXdRp4xITDB0s=", 7 | "owner": "numtide", 8 | "repo": "flake-utils", 9 | "rev": "f7e004a55b120c02ecb6219596820fcd32ca8772", 10 | "type": "github" 11 | }, 12 | "original": { 13 | "owner": "numtide", 14 | "repo": "flake-utils", 15 | "type": "github" 16 | } 17 | }, 18 | "nixpkgs": { 19 | "locked": { 20 | "lastModified": 1625522950, 21 | "narHash": "sha256-101L0cQyYYmC0TP2PvukJkkzp4qnbo8AAjw879OTKXw=", 22 | "owner": "NixOS", 23 | "repo": "nixpkgs", 24 | "rev": "976791a768ae57b66718e1ba52c86d2e66462187", 25 | "type": "github" 26 | }, 27 | "original": { 28 | "id": "nixpkgs", 29 | "type": "indirect" 30 | } 31 | }, 32 | "root": { 33 | "inputs": { 34 | "flake-utils": "flake-utils", 35 | "nixpkgs": "nixpkgs" 36 | } 37 | } 38 | }, 39 | "root": "root", 40 | "version": 7 41 | } 42 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | description = "A dmenu wrapper over bitwarden cli"; 3 | 4 | inputs.flake-utils.url = "github:numtide/flake-utils"; 5 | 6 | outputs = { self, nixpkgs, flake-utils }: 7 | flake-utils.lib.eachDefaultSystem (system: 8 | let pkgs = nixpkgs.legacyPackages.${system}; 9 | in rec { 10 | packages = 11 | flake-utils.lib.flattenTree { bwmenu = import ./. { inherit pkgs; }; }; 12 | defaultPackage = packages.bwmenu; 13 | apps.bwmenu = flake-utils.lib.mkApp { drv = packages.bwmenu; }; 14 | defaultApp = apps.bwmenu; 15 | }); 16 | } 17 | -------------------------------------------------------------------------------- /img/screenshot1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pltanton/bitwarden-dmenu/928663af71a491c85ae0602bd7700cf5d6788bea/img/screenshot1.png -------------------------------------------------------------------------------- /img/screenshot2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pltanton/bitwarden-dmenu/928663af71a491c85ae0602bd7700cf5d6788bea/img/screenshot2.png -------------------------------------------------------------------------------- /lib-bwmenu: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Helper functions 3 | 4 | # Extract item or items matching .name, including deduplication 5 | # $1: item name, prepended or not with deduplication mark 6 | array_from_name() { 7 | item_name="$(echo "$1" | sed "s/$DEDUP_MARK //")" 8 | echo "$ITEMS" | jq -r ". | map(select((.name == \"$item_name\") and (.type == $TYPE_LOGIN)))" 9 | } 10 | 11 | # Extract item matching .id 12 | # $1: string starting with ".id:" 13 | array_from_id() { 14 | echo "$ITEMS" | jq -r ". | map(select(.id == \"$1\"))" 15 | } 16 | 17 | # Count the number of items in an array. Return true if more than 1 or none 18 | # $1: Array of items 19 | not_unique() { 20 | item_count=$(echo "$1" | jq -r '. | length') 21 | ! [[ $item_count -eq 1 ]] 22 | } 23 | 24 | # Pipe a document and deduplicate lines. 25 | # Mark those duplicated by prepending $DEDUP_MARK 26 | dedup_lines() { 27 | sort | uniq -c | 28 | sed "s/^\s*1 //" | 29 | sed -r "s/^\s*[0-9]+ /$DEDUP_MARK /" 30 | } 31 | --------------------------------------------------------------------------------