├── .dir-locals.el ├── .github └── workflows │ └── test.yml ├── .gitignore ├── CONTRIBUTING.md ├── COPYING ├── Makefile ├── README.md ├── auth-source-pass.el └── test └── auth-source-pass-tests.el /.dir-locals.el: -------------------------------------------------------------------------------- 1 | ((emacs-lisp-mode 2 | (eval . (flycheck-mode)) 3 | (eval . (checkdoc-minor-mode)) 4 | (indent-tabs-mode . nil) 5 | (fill-column . 80) 6 | (sentence-end-double-space . t) 7 | (emacs-lisp-docstring-fill-column . 75))) 8 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | pull_request: 5 | push: 6 | 7 | jobs: 8 | test: 9 | runs-on: ubuntu-latest 10 | strategy: 11 | matrix: 12 | emacs_version: 13 | - 27.1 14 | steps: 15 | - name: Set up Emacs 16 | uses: purcell/setup-emacs@master 17 | with: 18 | version: ${{matrix.emacs_version}} 19 | 20 | - name: Check out the source code 21 | uses: actions/checkout@v2 22 | 23 | - name: Test the project 24 | run: | 25 | make install-elpa-dependencies 26 | make check 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated files 2 | *.elc 3 | *-pkg.el 4 | *.tar 5 | TAGS 6 | doc/auth-password-store.texi 7 | doc/auth-password-store.info 8 | 9 | # Packages 10 | .cask 11 | elpa 12 | /dist 13 | /makel.mk 14 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Contributions are welcome. If you discover bugs or issues, or have ideas for 4 | improvements or new features, please file a report on the issue tracker for this 5 | repository. Follow the guidelines below to make sure everything goes smoothly. 6 | 7 | ## Issue reporting 8 | 9 | - Check that the issue has not already been reported 10 | - Check that the issue has not already been fixed in the latest code 11 | - Open an issue with a clear title 12 | - Write as grammatically correct as you can in the description. 13 | 14 | ## Pull requests 15 | 16 | - Perform all changes on a topic branch for easier merging 17 | - Follow the coding conventions already in use 18 | - Verify Emacs Lisp code with `checkdoc` 19 | - Add unit tests whenever possible 20 | - Open a [pull request](https://help.github.com/articles/using-pull-requests) 21 | relating to a single issue. 22 | 23 | ## Coding Conventions 24 | 25 | ### Naming 26 | 27 | - Use a `auth-source-pass-` prefix for all public names. 28 | - Use a `auth-source-pass--` prefix for all internal names. 29 | 30 | ### Docstrings 31 | 32 | Write meaningful docstrings for all functions and vars. 33 | 34 | - Document all functions and variables as directed by `checkdoc`. 35 | - Consider using [Flycheck](https://github.com/flycheck/flycheck) to automate 36 | `checkdoc` while you're editing. 37 | 38 | ### Common Lisp functions 39 | 40 | Use `cl-lib` instead of `cl`. The `cl` library pollutes the global namespace and 41 | its usage is therefore discouraged. 42 | 43 | - Use `cl-lib`, which adds prefixes to all cl function names 44 | - Use [noflet](https://github.com/nicferrier/emacs-noflet) instead of `flet` 45 | when you need to dynamically rebind functions. 46 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ELPA_DEPENDENCIES=package-lint let-alist 2 | 3 | ELPA_ARCHIVES=melpa gnu 4 | 5 | LINT_PACKAGE_LINT_FILES=auth-source-pass.el 6 | TEST_ERT_FILES=test/auth-source-pass-tests.el 7 | LINT_CHECKDOC_FILES=${LINT_PACKAGE_LINT_FILES} ${TEST_ERT_FILES} 8 | LINT_COMPILE_FILES=${LINT_CHECKDOC_FILES} 9 | 10 | makel.mk: 11 | # Download makel 12 | @if [ -f ../makel/makel.mk ]; then \ 13 | ln -s ../makel/makel.mk .; \ 14 | else \ 15 | curl \ 16 | --fail --silent --show-error --insecure --location \ 17 | --retry 9 --retry-delay 9 \ 18 | -O https://gitea.petton.fr/DamienCassou/makel/raw/tag/v0.6.0/makel.mk; \ 19 | fi 20 | 21 | # Include makel.mk if present 22 | -include makel.mk 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | This project has been integrated into Emacs. As a consequence, I'm 2 | closing this repository. Please consider contributing to Emacs 3 | directly. 4 | -------------------------------------------------------------------------------- /auth-source-pass.el: -------------------------------------------------------------------------------- 1 | ;;; auth-source-pass.el --- Integrate auth-source with password-store -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2015, 2017-2020 Free Software Foundation, Inc. 4 | 5 | ;; Author: Damien Cassou , 6 | ;; Nicolas Petton 7 | ;; Keith Amidon 8 | ;; Version: 5.0.0 9 | ;; Package-Requires: ((emacs "27.1")) 10 | ;; Url: https://github.com/DamienCassou/auth-source-pass 11 | ;; Created: 07 Jun 2015 12 | 13 | ;; This file is part of GNU Emacs. 14 | 15 | ;; GNU Emacs is free software: you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | 20 | ;; GNU Emacs is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with GNU Emacs. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;; Integrates password-store (http://passwordstore.org/) within 31 | ;; auth-source. 32 | 33 | ;;; Code: 34 | 35 | (require 'seq) 36 | (eval-when-compile (require 'subr-x)) 37 | (require 'cl-lib) 38 | (require 'auth-source) 39 | (require 'url-parse) 40 | 41 | (defgroup auth-source-pass nil 42 | "password-store integration within auth-source." 43 | :prefix "auth-source-pass-" 44 | :group 'auth-source 45 | :version "27.1") 46 | 47 | (defcustom auth-source-pass-filename 48 | (or (getenv "PASSWORD_STORE_DIR") "~/.password-store") 49 | "Filename of the password-store folder." 50 | :type 'directory 51 | :version "27.1") 52 | 53 | (defcustom auth-source-pass-port-separator ":" 54 | "Separator string between host and port in entry filename." 55 | :type 'string 56 | :version "27.1") 57 | 58 | (cl-defun auth-source-pass-search (&rest spec 59 | &key backend type host user port 60 | &allow-other-keys) 61 | "Given some search query, return matching credentials. 62 | 63 | See `auth-source-search' for details on the parameters SPEC, BACKEND, TYPE, 64 | HOST, USER and PORT." 65 | (cl-assert (or (null type) (eq type (oref backend type))) 66 | t "Invalid password-store search: %s %s") 67 | (cond ((eq host t) 68 | (warn "auth-source-pass does not handle host wildcards.") 69 | nil) 70 | ((null host) 71 | ;; Do not build a result, as none will match when HOST is nil 72 | nil) 73 | (t 74 | (when-let ((result (auth-source-pass--build-result host port user))) 75 | (list result))))) 76 | 77 | (defun auth-source-pass--build-result (hosts port user) 78 | "Build auth-source-pass entry matching HOSTS, PORT and USER. 79 | 80 | HOSTS can be a string or a list of strings." 81 | (let ((entry-data (auth-source-pass--find-match hosts user port))) 82 | (when entry-data 83 | (let ((retval (list 84 | :host (auth-source-pass--get-attr "host" entry-data) 85 | :port (or (auth-source-pass--get-attr "port" entry-data) port) 86 | :user (or (auth-source-pass--get-attr "user" entry-data) user) 87 | :secret (lambda () (auth-source-pass--get-attr 'secret entry-data))))) 88 | (auth-source-pass--do-debug "return %s as final result (plus hidden password)" 89 | (seq-subseq retval 0 -2)) ;; remove password 90 | retval)))) 91 | 92 | ;;;###autoload 93 | (defun auth-source-pass-enable () 94 | "Enable auth-source-password-store." 95 | ;; To add password-store to the list of sources, evaluate the following: 96 | (add-to-list 'auth-sources 'password-store) 97 | ;; clear the cache (required after each change to #'auth-source-pass-search) 98 | (auth-source-forget-all-cached)) 99 | 100 | (defvar auth-source-pass-backend 101 | (auth-source-backend 102 | (when (<= emacs-major-version 25) "password-store") 103 | :source "." ;; not used 104 | :type 'password-store 105 | :search-function #'auth-source-pass-search) 106 | "Auth-source backend for password-store.") 107 | 108 | (defun auth-source-pass-backend-parse (entry) 109 | "Create a password-store auth-source backend from ENTRY." 110 | (when (eq entry 'password-store) 111 | (auth-source-backend-parse-parameters entry auth-source-pass-backend))) 112 | 113 | (if (boundp 'auth-source-backend-parser-functions) 114 | (add-hook 'auth-source-backend-parser-functions #'auth-source-pass-backend-parse) 115 | (advice-add 'auth-source-backend-parse :before-until #'auth-source-pass-backend-parse)) 116 | 117 | 118 | ;;;###autoload 119 | (defun auth-source-pass-get (key entry) 120 | "Return the value associated to KEY in the password-store entry ENTRY. 121 | 122 | ENTRY is the name of a password-store entry. 123 | The key used to retrieve the password is the symbol `secret'. 124 | 125 | The convention used as the format for a password-store file is the 126 | following (see URL `http://www.passwordstore.org/#organization'): 127 | 128 | secret 129 | key1: value1 130 | key2: value2" 131 | (let ((data (auth-source-pass-parse-entry entry))) 132 | (auth-source-pass--get-attr key data))) 133 | 134 | (defun auth-source-pass--get-attr (key entry-data) 135 | "Return value associated with KEY in an ENTRY-DATA. 136 | 137 | ENTRY-DATA is the data from a parsed password-store entry. 138 | The key used to retrieve the password is the symbol `secret'. 139 | 140 | See `auth-source-pass-get'." 141 | (or (cdr (assoc key entry-data)) 142 | (and (string= key "user") 143 | (cdr (assoc "username" entry-data))))) 144 | 145 | (defun auth-source-pass--read-entry (entry) 146 | "Return a string with the file content of ENTRY." 147 | (with-temp-buffer 148 | (insert-file-contents (expand-file-name 149 | (format "%s.gpg" entry) 150 | auth-source-pass-filename)) 151 | (buffer-substring-no-properties (point-min) (point-max)))) 152 | 153 | (defun auth-source-pass-parse-entry (entry) 154 | "Return an alist of the data associated with ENTRY. 155 | 156 | ENTRY is the name of a password-store entry." 157 | (let ((file-contents (ignore-errors (auth-source-pass--read-entry entry)))) 158 | (and file-contents 159 | (cons `(secret . ,(auth-source-pass--parse-secret file-contents)) 160 | (auth-source-pass--parse-data file-contents))))) 161 | 162 | (defun auth-source-pass--parse-secret (contents) 163 | "Parse the password-store data in the string CONTENTS and return its secret. 164 | The secret is the first line of CONTENTS." 165 | (car (split-string contents "\n" t))) 166 | 167 | (defun auth-source-pass--parse-data (contents) 168 | "Parse the password-store data in the string CONTENTS and return an alist. 169 | CONTENTS is the contents of a password-store formatted file." 170 | (let ((lines (cdr (split-string contents "\n" t "[ \t]+")))) 171 | (seq-remove #'null 172 | (mapcar (lambda (line) 173 | (when-let ((pos (seq-position line ?:))) 174 | (cons (string-trim (substring line 0 pos)) 175 | (string-trim (substring line (1+ pos)))))) 176 | lines)))) 177 | 178 | (defun auth-source-pass--do-debug (&rest msg) 179 | "Call `auth-source-do-debug` with MSG and a prefix." 180 | (apply #'auth-source-do-debug 181 | (cons (concat "auth-source-pass: " (car msg)) 182 | (cdr msg)))) 183 | 184 | ;; TODO: add tests for that when `assess-with-filesystem' is included 185 | ;; in Emacs 186 | (defun auth-source-pass-entries () 187 | "Return a list of all password store entries." 188 | (let ((store-dir (expand-file-name auth-source-pass-filename))) 189 | (mapcar 190 | (lambda (file) (file-name-sans-extension (file-relative-name file store-dir))) 191 | (directory-files-recursively store-dir "\\.gpg\\'")))) 192 | 193 | (defun auth-source-pass--find-match (hosts user port) 194 | "Return password-store entry data matching HOSTS, USER and PORT. 195 | 196 | Disambiguate between user provided inside HOSTS (e.g., user@server.com) and 197 | inside USER by giving priority to USER. Same for PORT. 198 | HOSTS can be a string or a list of strings." 199 | (seq-some (lambda (host) 200 | (let ((entry (apply #'auth-source-pass--find-match-unambiguous 201 | (auth-source-pass--disambiguate host user port)))) 202 | (if (or (null entry) (assoc "host" entry)) 203 | entry 204 | (cons (cons "host" host) entry)))) 205 | (if (listp hosts) 206 | hosts 207 | (list hosts)))) 208 | 209 | (defun auth-source-pass--disambiguate (host &optional user port) 210 | "Return (HOST USER PORT) after disambiguation. 211 | Disambiguate between having user provided inside HOST (e.g., 212 | user@server.com) and inside USER by giving priority to USER. 213 | Same for PORT." 214 | (let* ((url (url-generic-parse-url (if (string-match-p ".*://" host) 215 | host 216 | (format "https://%s" host))))) 217 | (list 218 | (or (url-host url) host) 219 | (or user (url-user url)) 220 | ;; url-port returns 443 (because of the https:// above) by default 221 | (or port (number-to-string (url-port url)))))) 222 | 223 | (defun auth-source-pass--find-match-unambiguous (hostname user port) 224 | "Return password-store entry data matching HOSTNAME, USER and PORT. 225 | If many matches are found, return the first one. If no match is found, 226 | return nil. 227 | 228 | HOSTNAME should not contain any username or port number." 229 | (let ((all-entries (auth-source-pass-entries)) 230 | (suffixes (auth-source-pass--generate-entry-suffixes hostname user port))) 231 | (auth-source-pass--do-debug "searching for entries matching hostname=%S, user=%S, port=%S" 232 | hostname (or user "") (or port "")) 233 | (auth-source-pass--do-debug "corresponding suffixes to search for: %S" suffixes) 234 | (catch 'auth-source-pass-break 235 | (dolist (suffix suffixes) 236 | (let* ((matching-entries (auth-source-pass--entries-matching-suffix suffix all-entries)) 237 | (best-entry-data (auth-source-pass--select-from-entries matching-entries user))) 238 | (pcase (length matching-entries) 239 | (0 (auth-source-pass--do-debug "found no entries matching %S" suffix)) 240 | (1 (auth-source-pass--do-debug "found 1 entry matching %S: %S" 241 | suffix 242 | (car matching-entries))) 243 | (_ (auth-source-pass--do-debug "found %s entries matching %S: %S" 244 | (length matching-entries) 245 | suffix 246 | matching-entries))) 247 | (when best-entry-data 248 | (throw 'auth-source-pass-break best-entry-data))))))) 249 | 250 | (defun auth-source-pass--select-from-entries (entries user) 251 | "Return best matching password-store entry data from ENTRIES. 252 | 253 | If USER is non-nil, give precedence to entries containing a user field 254 | matching USER." 255 | (let (fallback) 256 | (catch 'auth-source-pass-break 257 | (dolist (entry entries fallback) 258 | (let ((entry-data (auth-source-pass-parse-entry entry))) 259 | (when (and entry-data (not fallback)) 260 | (setq fallback entry-data) 261 | (when (or (not user) (equal (auth-source-pass--get-attr "user" entry-data) user)) 262 | (throw 'auth-source-pass-break entry-data)))))))) 263 | 264 | (defun auth-source-pass--entries-matching-suffix (suffix entries) 265 | "Return entries matching SUFFIX. 266 | If ENTRIES is nil, use the result of calling `auth-source-pass-entries' instead." 267 | (cl-remove-if-not 268 | (lambda (entry) (string-match-p 269 | (format "\\(^\\|/\\)%s$" (regexp-quote suffix)) 270 | entry)) 271 | (or entries (auth-source-pass-entries)))) 272 | 273 | (defun auth-source-pass--generate-entry-suffixes (hostname user port) 274 | "Return a list of possible entry path suffixes in the password-store. 275 | 276 | Based on the supported pathname patterns for HOSTNAME, USER, & 277 | PORT, return a list of possible suffixes for matching entries in 278 | the password-store. 279 | 280 | PORT may be a list of ports." 281 | (let ((domains (auth-source-pass--domains (split-string hostname "\\.")))) 282 | (seq-mapcat (lambda (domain) 283 | (seq-mapcat 284 | (lambda (p) 285 | (auth-source-pass--name-port-user-suffixes domain user p)) 286 | (if (consp port) port (list port)))) 287 | domains))) 288 | 289 | (defun auth-source-pass--domains (name-components) 290 | "Return a list of possible domain names matching the hostname. 291 | 292 | This function takes a list of NAME-COMPONENTS, the strings 293 | separated by periods in the hostname, and returns a list of full 294 | domain names containing the trailing sequences of those 295 | components, from longest to shortest." 296 | (cl-maplist (lambda (components) (mapconcat #'identity components ".")) 297 | name-components)) 298 | 299 | (defun auth-source-pass--name-port-user-suffixes (name user port) 300 | "Return a list of possible path suffixes for NAME, USER, & PORT. 301 | 302 | The resulting list is ordered from most specific to least 303 | specific, with paths matching all of NAME, USER, & PORT first, 304 | then NAME & USER, then NAME & PORT, then just NAME." 305 | (seq-mapcat 306 | #'identity 307 | (list 308 | (when (and user port) 309 | (list 310 | (format "%s@%s%s%s" user name auth-source-pass-port-separator port) 311 | (format "%s%s%s/%s" name auth-source-pass-port-separator port user))) 312 | (when user 313 | (list 314 | (format "%s@%s" user name) 315 | (format "%s/%s" name user))) 316 | (when port 317 | (list 318 | (format "%s%s%s" name auth-source-pass-port-separator port))) 319 | (list 320 | (format "%s" name))))) 321 | 322 | (provide 'auth-source-pass) 323 | ;;; auth-source-pass.el ends here 324 | 325 | ;; LocalWords: backend hostname 326 | -------------------------------------------------------------------------------- /test/auth-source-pass-tests.el: -------------------------------------------------------------------------------- 1 | ;;; auth-source-pass-tests.el --- Tests for auth-source-pass.el -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2013, 2017-2019 Free Software Foundation, Inc. 4 | 5 | ;; Author: Damien Cassou 6 | 7 | ;; This file is part of GNU Emacs. 8 | 9 | ;; GNU Emacs is free software: you can redistribute it and/or modify 10 | ;; it under the terms of the GNU General Public License as published by 11 | ;; the Free Software Foundation, either version 3 of the License, or 12 | ;; (at your option) any later version. 13 | 14 | ;; GNU Emacs is distributed in the hope that it will be useful, 15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | ;; GNU General Public License for more details. 18 | 19 | ;; You should have received a copy of the GNU General Public License 20 | ;; along with GNU Emacs. If not, see . 21 | 22 | ;;; Commentary: 23 | 24 | ;; Tests for auth-source-pass.el 25 | 26 | ;;; Code: 27 | 28 | (require 'ert) 29 | 30 | (require 'auth-source-pass) 31 | 32 | (eval-when-compile (require 'cl-lib)) 33 | 34 | (ert-deftest auth-source-pass-parse-simple () 35 | (let ((content "pass\nkey1:val1\nkey2:val2\n")) 36 | (should (equal (auth-source-pass--parse-data content) 37 | '(("key1" . "val1") 38 | ("key2" . "val2")))))) 39 | 40 | (ert-deftest auth-source-pass-parse-with-dash-line () 41 | (let ((content "pass\n--\nkey1:val1\nkey2:val2\n")) 42 | (should (equal (auth-source-pass--parse-data content) 43 | '(("key1" . "val1") 44 | ("key2" . "val2")))))) 45 | 46 | (ert-deftest auth-source-pass-parse-with-trailing-spaces () 47 | (let ((content "pass\n--\nkey1 :val1 \nkey2: val2\n\n")) 48 | (should (equal (auth-source-pass--parse-data content) 49 | '(("key1" . "val1") 50 | ("key2" . "val2")))))) 51 | 52 | (ert-deftest auth-source-pass-parse-with-colons-in-data () 53 | (let ((content "pass\n--\nkey1 :val1\nkey2: please: keep my space after colon\n\n")) 54 | (should (equal (auth-source-pass--parse-data content) 55 | '(("key1" . "val1") 56 | ("key2" . "please: keep my space after colon")))))) 57 | 58 | (defvar auth-source-pass--debug-log nil 59 | "Contains a list of all messages passed to `auth-source-do-debug`.") 60 | 61 | (defun auth-source-pass--have-message-matching (regexp) 62 | "Return non-nil iff at least one `auth-source-do-debug` match REGEXP." 63 | (seq-find (lambda (message) 64 | (string-match regexp message)) 65 | auth-source-pass--debug-log)) 66 | 67 | (defun auth-source-pass--explain--have-message-matching (regexp) 68 | "Explainer function for `auth-source-pass--have-message-matching'. 69 | REGEXP is the same as in `auth-source-pass--have-message-matching'." 70 | `(regexp 71 | ,regexp 72 | messages 73 | ,(mapconcat #'identity auth-source-pass--debug-log "\n- "))) 74 | 75 | (put #'auth-source-pass--have-message-matching 'ert-explainer #'auth-source-pass--explain--have-message-matching) 76 | 77 | (defun auth-source-pass--debug (&rest msg) 78 | "Format MSG and add that to `auth-source-pass--debug-log`. 79 | This function is intended to be set to `auth-source-debug`." 80 | (add-to-list 'auth-source-pass--debug-log (apply #'format msg) t)) 81 | 82 | (defvar auth-source-pass--parse-log nil) 83 | 84 | (defmacro auth-source-pass--with-store (store &rest body) 85 | "Use STORE as password-store while executing BODY." 86 | (declare (indent 1)) 87 | `(cl-letf (((symbol-function 'auth-source-pass-parse-entry) 88 | (lambda (entry) 89 | (add-to-list 'auth-source-pass--parse-log entry) 90 | (cdr (cl-find entry ,store :key #'car :test #'string=)))) 91 | ((symbol-function 'auth-source-pass-entries) (lambda () (mapcar #'car ,store)))) 92 | (let ((auth-source-debug #'auth-source-pass--debug) 93 | (auth-source-pass--debug-log nil) 94 | (auth-source-pass--parse-log nil)) 95 | ,@body))) 96 | 97 | (defun auth-source-pass--explain-match-entry-p (entry hostname &optional user port) 98 | "Explainer function for `auth-source-pass-match-entry-p'. 99 | 100 | ENTRY, HOSTNAME, USER and PORT are the same as in `auth-source-pass-match-entry-p'." 101 | `(entry 102 | ,entry 103 | store 104 | ,(auth-source-pass-entries) 105 | matching-entries 106 | ,(auth-source-pass--matching-entries hostname user port))) 107 | 108 | (put 'auth-source-pass-match-entry-p 'ert-explainer #'auth-source-pass--explain-match-entry-p) 109 | 110 | (defun auth-source-pass--includes-sorted-entries (entries hostname &optional user port) 111 | "Return non-nil iff ENTRIES matching the parameters are found in store. 112 | ENTRIES should be sorted from most specific to least specific. 113 | 114 | HOSTNAME, USER and PORT are passed unchanged to 115 | `auth-source-pass--matching-entries'." 116 | (if (seq-empty-p entries) 117 | t 118 | (and 119 | (auth-source-pass-match-entry-p (car entries) hostname user port) 120 | (auth-source-pass--includes-sorted-entries (cdr entries) hostname user port)))) 121 | 122 | (defun auth-source-pass--explain-includes-sorted-entries (entries hostname &optional user port) 123 | "Explainer function for `auth-source-pass--includes-sorted-entries'. 124 | 125 | ENTRIES, HOSTNAME, USER and PORT are the same as in `auth-source-pass--includes-sorted-entries'." 126 | `(store 127 | ,(auth-source-pass-entries) 128 | matching-entries 129 | ,(auth-source-pass--matching-entries hostname user port) 130 | entries 131 | ,entries)) 132 | 133 | (put 'auth-source-pass--includes-sorted-entries 'ert-explainer #'auth-source-pass--explain-includes-sorted-entries) 134 | 135 | (defun auth-source-pass--explain-match-any-entry-p (hostname &optional user port) 136 | "Explainer function for `auth-source-pass-match-any-entry-p'. 137 | 138 | HOSTNAME, USER and PORT are the same as in `auth-source-pass-match-any-entry-p'." 139 | `(store 140 | ,(auth-source-pass-entries) 141 | matching-entries 142 | ,(auth-source-pass--matching-entries hostname user port))) 143 | 144 | (put 'auth-source-pass-match-any-entry-p 'ert-explainer #'auth-source-pass--explain-match-any-entry-p) 145 | 146 | (defun auth-source-pass--matching-entries (hostname &optional user port) 147 | "Return password-store entries matching HOSTNAME, USER, PORT. 148 | 149 | The result is a list of lists of password-store entries. Each 150 | sublist contains the password-store entries whose names match a 151 | suffix in `auth-source-pass--generate-entry-suffixes'. The 152 | result is ordered the same way as the suffixes." 153 | (let ((entries (auth-source-pass-entries))) 154 | (mapcar (lambda (suffix) (auth-source-pass--entries-matching-suffix suffix entries)) 155 | (auth-source-pass--generate-entry-suffixes hostname user port)))) 156 | 157 | (defun auth-source-pass-match-entry-p (entry hostname &optional user port) 158 | "Return non-nil iff an ENTRY matching the parameters is found in store. 159 | 160 | HOSTNAME, USER and PORT are passed unchanged to 161 | `auth-source-pass--matching-entries'." 162 | (cl-find-if 163 | (lambda (entries) (cl-find entry entries :test #'string=)) 164 | (auth-source-pass--matching-entries hostname user port))) 165 | 166 | (defun auth-source-pass-match-any-entry-p (hostname &optional user port) 167 | "Return non-nil iff there is at least one entry matching the parameters. 168 | 169 | HOSTNAME, USER and PORT are passed unchanged to 170 | `auth-source-pass--matching-entries'." 171 | (cl-find-if #'identity (auth-source-pass--matching-entries hostname user port))) 172 | 173 | (ert-deftest auth-source-pass-any-host () 174 | (auth-source-pass--with-store '(("foo" ("port" . "foo-port") ("host" . "foo-user")) 175 | ("bar")) 176 | (should-not (auth-source-pass-search :host t)))) 177 | 178 | (ert-deftest auth-source-pass-undefined-host () 179 | (auth-source-pass--with-store '(("foo" ("port" . "foo-port") ("host" . "foo-user")) 180 | ("bar")) 181 | (should-not (auth-source-pass-search :host nil)))) 182 | 183 | (ert-deftest auth-source-pass-not-found () 184 | (auth-source-pass--with-store '(("foo" ("port" . "foo-port") ("host" . "foo-user")) 185 | ("bar")) 186 | (should-not (auth-source-pass-search :host "baz")))) 187 | 188 | (ert-deftest auth-source-pass--disambiguate-extract-host-from-hostname () 189 | ;; no user or port 190 | (should (equal (cl-first (auth-source-pass--disambiguate "foo")) "foo")) 191 | ;; only user 192 | (should (equal (cl-first (auth-source-pass--disambiguate "user@foo")) "foo")) 193 | ;; only port 194 | (should (equal (cl-first (auth-source-pass--disambiguate "https://foo")) "foo")) 195 | (should (equal (cl-first (auth-source-pass--disambiguate "foo:80")) "foo")) 196 | ;; both user and port 197 | (should (equal (cl-first (auth-source-pass--disambiguate "https://user@foo")) "foo")) 198 | (should (equal (cl-first (auth-source-pass--disambiguate "user@foo:80")) "foo")) 199 | ;; all of the above with a trailing path 200 | (should (equal (cl-first (auth-source-pass--disambiguate "foo/path")) "foo")) 201 | (should (equal (cl-first (auth-source-pass--disambiguate "user@foo/path")) "foo")) 202 | (should (equal (cl-first (auth-source-pass--disambiguate "https://foo/path")) "foo")) 203 | (should (equal (cl-first (auth-source-pass--disambiguate "foo:80/path")) "foo")) 204 | (should (equal (cl-first (auth-source-pass--disambiguate "https://user@foo/path")) "foo")) 205 | (should (equal (cl-first (auth-source-pass--disambiguate "user@foo:80/path")) "foo"))) 206 | 207 | (ert-deftest auth-source-pass--disambiguate-extract-user-from-hostname () 208 | ;; no user or port 209 | (should (equal (cl-second (auth-source-pass--disambiguate "foo")) nil)) 210 | ;; only user 211 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo")) "user")) 212 | ;; only port 213 | (should (equal (cl-second (auth-source-pass--disambiguate "https://foo")) nil)) 214 | (should (equal (cl-second (auth-source-pass--disambiguate "foo:80")) nil)) 215 | ;; both user and port 216 | (should (equal (cl-second (auth-source-pass--disambiguate "https://user@foo")) "user")) 217 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo:80")) "user")) 218 | ;; all of the above with a trailing path 219 | (should (equal (cl-second (auth-source-pass--disambiguate "foo/path")) nil)) 220 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo/path")) "user")) 221 | (should (equal (cl-second (auth-source-pass--disambiguate "https://foo/path")) nil)) 222 | (should (equal (cl-second (auth-source-pass--disambiguate "foo:80/path")) nil)) 223 | (should (equal (cl-second (auth-source-pass--disambiguate "https://user@foo/path")) "user")) 224 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo:80/path")) "user"))) 225 | 226 | (ert-deftest auth-source-pass--disambiguate-prefer-user-parameter () 227 | ;; no user or port 228 | (should (equal (cl-second (auth-source-pass--disambiguate "foo" "user2")) "user2")) 229 | ;; only user 230 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo" "user2")) "user2")) 231 | ;; only port 232 | (should (equal (cl-second (auth-source-pass--disambiguate "https://foo" "user2")) "user2")) 233 | (should (equal (cl-second (auth-source-pass--disambiguate "foo:80" "user2")) "user2")) 234 | ;; both user and port 235 | (should (equal (cl-second (auth-source-pass--disambiguate "https://user@foo" "user2")) "user2")) 236 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo:80" "user2")) "user2")) 237 | ;; all of the above with a trailing path 238 | (should (equal (cl-second (auth-source-pass--disambiguate "foo/path" "user2")) "user2")) 239 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo/path" "user2")) "user2")) 240 | (should (equal (cl-second (auth-source-pass--disambiguate "https://foo/path" "user2")) "user2")) 241 | (should (equal (cl-second (auth-source-pass--disambiguate "foo:80/path" "user2")) "user2")) 242 | (should (equal (cl-second (auth-source-pass--disambiguate "https://user@foo/path" "user2")) "user2")) 243 | (should (equal (cl-second (auth-source-pass--disambiguate "user@foo:80/path" "user2")) "user2"))) 244 | 245 | (ert-deftest auth-source-pass--disambiguate-extract-port-from-hostname () 246 | ;; no user or port 247 | (should (equal (cl-third (auth-source-pass--disambiguate "foo")) "443")) 248 | ;; only user 249 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo")) "443")) 250 | ;; only port 251 | (should (equal (cl-third (auth-source-pass--disambiguate "https://foo")) "443")) 252 | (should (equal (cl-third (auth-source-pass--disambiguate "foo:80")) "80")) 253 | ;; both user and port 254 | (should (equal (cl-third (auth-source-pass--disambiguate "https://user@foo")) "443")) 255 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo:80")) "80")) 256 | ;; all of the above with a trailing path 257 | (should (equal (cl-third (auth-source-pass--disambiguate "foo/path")) "443")) 258 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo/path")) "443")) 259 | (should (equal (cl-third (auth-source-pass--disambiguate "https://foo/path")) "443")) 260 | (should (equal (cl-third (auth-source-pass--disambiguate "foo:80/path")) "80")) 261 | (should (equal (cl-third (auth-source-pass--disambiguate "https://user@foo/path")) "443")) 262 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo:80/path")) "80"))) 263 | 264 | (ert-deftest auth-source-pass--disambiguate-prefer-port-parameter () 265 | ;; no user or port 266 | (should (equal (cl-third (auth-source-pass--disambiguate "foo" "user2" "8080")) "8080")) 267 | ;; only user 268 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo" "user2" "8080")) "8080")) 269 | ;; only port 270 | (should (equal (cl-third (auth-source-pass--disambiguate "https://foo" "user2" "8080")) "8080")) 271 | (should (equal (cl-third (auth-source-pass--disambiguate "foo:80" "user2" "8080")) "8080")) 272 | ;; both user and port 273 | (should (equal (cl-third (auth-source-pass--disambiguate "https://user@foo" "user2" "8080")) "8080")) 274 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo:80" "user2" "8080")) "8080")) 275 | ;; all of the above with a trailing path 276 | (should (equal (cl-third (auth-source-pass--disambiguate "foo/path" "user2" "8080")) "8080")) 277 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo/path" "user2" "8080")) "8080")) 278 | (should (equal (cl-third (auth-source-pass--disambiguate "https://foo/path" "user2" "8080")) "8080")) 279 | (should (equal (cl-third (auth-source-pass--disambiguate "foo:80/path" "user2" "8080")) "8080")) 280 | (should (equal (cl-third (auth-source-pass--disambiguate "https://user@foo/path" "user2" "8080")) "8080")) 281 | (should (equal (cl-third (auth-source-pass--disambiguate "user@foo:80/path" "user2" "8080")) "8080"))) 282 | 283 | (ert-deftest auth-source-pass-find-match-minimal-parsing () 284 | (let ((store-contents 285 | '(("baz" ("secret" . "baz password")) 286 | ("baz:123" ("secret" . "baz:123 password")) 287 | ("baz/foo" ("secret" . "baz/foo password")) 288 | ("foo@baz" ("secret" . "foo@baz password")) 289 | ("baz:123/foo" ("secret" . "baz:123/foo password")) 290 | ("foo@baz:123" ("secret" . "foo@baz:123 password")) 291 | ("bar.baz" ("secret" . "bar.baz password")) 292 | ("bar.baz:123" ("secret" . "bar.baz:123 password")) 293 | ("bar.baz/foo" ("secret" . "bar.baz/foo password")) 294 | ("foo@bar.baz" ("secret" . "foo@bar.baz password")) 295 | ("bar.baz:123/foo" ("secret" . "bar.baz:123/foo password")) 296 | ("foo@bar.baz:123" ("secret" . "foo@bar.baz:123 password"))))) 297 | (auth-source-pass--with-store store-contents 298 | (auth-source-pass--find-match "bar.baz" "foo" "123") 299 | (should (equal auth-source-pass--parse-log '("foo@bar.baz:123")))) 300 | (auth-source-pass--with-store store-contents 301 | (auth-source-pass--find-match "bar.baz" "foo" nil) 302 | (should (equal auth-source-pass--parse-log '("foo@bar.baz")))) 303 | (auth-source-pass--with-store store-contents 304 | (auth-source-pass--find-match "bar.baz" nil "123") 305 | (should (equal auth-source-pass--parse-log '("bar.baz:123")))) 306 | (auth-source-pass--with-store store-contents 307 | (auth-source-pass--find-match "bar.baz" nil nil) 308 | (should (equal auth-source-pass--parse-log '("bar.baz")))) 309 | (auth-source-pass--with-store store-contents 310 | (auth-source-pass--find-match "baz" nil nil) 311 | (should (equal auth-source-pass--parse-log '("baz")))) 312 | (auth-source-pass--with-store 313 | '(("dir1/bar.com" ("key" . "val")) 314 | ("dir2/bar.com" ("key" . "val")) 315 | ("dir3/bar.com" ("key" . "val"))) 316 | (auth-source-pass--find-match "bar.com" nil nil) 317 | (should (= (length auth-source-pass--parse-log) 1))))) 318 | 319 | (ert-deftest auth-source-pass--find-match-return-parsed-data () 320 | (auth-source-pass--with-store '(("bar.com" ("key" . "val"))) 321 | (should (consp (auth-source-pass--find-match "bar.com" nil nil)))) 322 | (auth-source-pass--with-store '(("dir1/bar.com" ("key1" . "val1")) ("dir2/bar.com" ("key2" . "val2"))) 323 | (should (consp (auth-source-pass--find-match "bar.com" nil nil))))) 324 | 325 | (ert-deftest auth-source-pass--matching-entries () 326 | (auth-source-pass--with-store '(("bar.com")) 327 | (should (auth-source-pass-match-entry-p "bar.com" "bar.com")) 328 | ;; match even if sub-domain is asked for 329 | (should (auth-source-pass-match-entry-p "bar.com" "foo.bar.com")) 330 | ;; match even if a user is asked for 331 | (should (auth-source-pass-match-entry-p "bar.com" "bar.com" "user")) 332 | ;; match even if user as an @ sign 333 | (should (auth-source-pass-match-entry-p "bar.com" "bar.com" "user@someplace")) 334 | ;; match even if a port is asked for 335 | (should (auth-source-pass-match-entry-p "bar.com" "bar.com" nil "8080")) 336 | ;; match even if a user and a port are asked for 337 | (should (auth-source-pass-match-entry-p "bar.com" "bar.com" "user" "8080")) 338 | ;; don't match if a '.' is replaced with another character 339 | (auth-source-pass--with-store '(("barXcom")) 340 | (should-not (auth-source-pass-match-any-entry-p "bar.com" nil nil))))) 341 | 342 | (ert-deftest auth-source-pass--matching-entries-find-entries-with-a-username () 343 | (auth-source-pass--with-store '(("user@foo")) 344 | (should (auth-source-pass-match-entry-p "user@foo" "foo" "user"))) 345 | ;; match even if sub-domain is asked for 346 | (auth-source-pass--with-store '(("user@bar.com")) 347 | (should (auth-source-pass-match-entry-p "user@bar.com" "foo.bar.com" "user"))) 348 | ;; don't match if no user is asked for 349 | (auth-source-pass--with-store '(("user@foo")) 350 | (should-not (auth-source-pass-match-any-entry-p "foo"))) 351 | ;; don't match if user is different 352 | (auth-source-pass--with-store '(("user1@foo")) 353 | (should-not (auth-source-pass-match-any-entry-p "foo" "user2"))) 354 | ;; don't match if sub-domain is asked for but user is different 355 | (auth-source-pass--with-store '(("user1@bar.com")) 356 | (should-not (auth-source-pass-match-any-entry-p "foo.bar.com" "user2")))) 357 | 358 | (ert-deftest auth-source-pass--matching-entries-find-entries-with-a-port () 359 | (auth-source-pass--with-store '(("bar.com:8080")) 360 | (should (auth-source-pass-match-entry-p "bar.com:8080" "bar.com" nil "8080")))) 361 | 362 | (ert-deftest auth-source-pass--matching-entries-find-entries-with-slash () 363 | ;; match if entry filename matches user 364 | (auth-source-pass--with-store '(("foo.com/user")) 365 | (should (auth-source-pass-match-entry-p "foo.com/user" "foo.com" "user"))) 366 | ;; match with port if entry filename matches user 367 | (auth-source-pass--with-store '(("foo.com:8080/user")) 368 | (should (auth-source-pass-match-entry-p "foo.com:8080/user" "foo.com" "user" "8080"))) 369 | ;; don't match if entry filename doesn't match user 370 | (auth-source-pass--with-store '(("foo.com/baz")) 371 | (should-not (auth-source-pass-match-any-entry-p "foo.com" "user")))) 372 | 373 | (ert-deftest auth-source-pass-matching-entries-with-custom-separator () 374 | (let ((auth-source-pass-port-separator "#")) 375 | (auth-source-pass--with-store '(("bar.com#443/someone")) 376 | (should (auth-source-pass-match-entry-p "bar.com#443/someone" "bar.com" "someone" "443"))))) 377 | 378 | (ert-deftest auth-source-pass--matching-entries-sort-results () 379 | (auth-source-pass--with-store '(("user@foo") ("foo")) 380 | (should (auth-source-pass--includes-sorted-entries '("user@foo" "foo") "foo" "user"))) 381 | ;; same, but store is reversed 382 | (auth-source-pass--with-store '(("foo") ("user@foo")) 383 | (should (auth-source-pass--includes-sorted-entries '("user@foo" "foo") "foo" "user"))) 384 | ;; with sub-domain 385 | (auth-source-pass--with-store '(("bar.com") ("foo.bar.com")) 386 | (should (auth-source-pass--includes-sorted-entries '("foo.bar.com" "bar.com") "foo.bar.com"))) 387 | ;; matching user in the entry data takes priority 388 | (auth-source-pass--with-store '(("dir1/bar.com") ("dir2/bar.com" ("user" . "user"))) 389 | (should (auth-source-pass--includes-sorted-entries 390 | '("dir2/bar.com" "dir1/bar.com") 391 | "bar.com" "user"))) 392 | ;; same, but store is reversed 393 | (auth-source-pass--with-store '(("dir2/bar.com" ("user" . "user")) ("dir1/bar.com")) 394 | (should (auth-source-pass--includes-sorted-entries 395 | '("dir2/bar.com" "dir1/bar.com") 396 | "bar.com" "user")))) 397 | 398 | (ert-deftest auth-source-pass-all-supported-organizations () 399 | ;; test every possible entry to store this data: user=rms host=gnu.org port=22 400 | (dolist (entry '(;; only host name 401 | "gnu.org" 402 | ;; hostname + user 403 | "gnu.org/rms" "rms@gnu.org" 404 | ;; hostname + port 405 | "gnu.org:22" 406 | ;; hostname + user + port 407 | "gnu.org:22/rms" "rms@gnu.org:22" 408 | ;; all of the above in a random folder 409 | "a/b/gnu.org" 410 | "a/b/gnu.org/rms" "a/b/rms@gnu.org" 411 | "a/b/gnu.org:22" 412 | "a/b/gnu.org:22/rms" "a/b/rms@gnu.org:22")) 413 | (auth-source-pass--with-store `((,entry)) 414 | (should (auth-source-pass-match-entry-p entry "gnu.org" "rms" "22"))))) 415 | 416 | (defmacro auth-source-pass--with-store-find-foo (store &rest body) 417 | "Use STORE while executing BODY. \"foo\" is the matched entry." 418 | (declare (indent 1)) 419 | `(auth-source-pass--with-store ,store 420 | (cl-letf (((symbol-function 'auth-source-pass-find-match) 421 | (lambda (_host _user) 422 | "foo"))) 423 | ,@body))) 424 | 425 | (ert-deftest auth-source-pass-build-result-return-parameters () 426 | (auth-source-pass--with-store-find-foo 427 | '(("foo" ("secret" . "foo password"))) 428 | (let ((result (auth-source-pass--build-result "foo" 512 "user"))) 429 | (should (equal (plist-get result :host) "foo")) 430 | (should (equal (plist-get result :port) 512)) 431 | (should (equal (plist-get result :user) "user"))))) 432 | 433 | (ert-deftest auth-source-pass-build-result-return-entry-values () 434 | (auth-source-pass--with-store-find-foo '(("foo" ("port" . 512) ("user" . "anuser"))) 435 | (let ((result (auth-source-pass--build-result "foo" nil nil))) 436 | (should (equal (plist-get result :host) "foo")) 437 | (should (equal (plist-get result :port) 512)) 438 | (should (equal (plist-get result :user) "anuser"))))) 439 | 440 | (ert-deftest auth-source-pass-build-result-entry-takes-precedence () 441 | (auth-source-pass--with-store-find-foo '(("foo" ("host" . "bar") ("port" . 512) ("user" . "anuser"))) 442 | (let ((result (auth-source-pass--build-result "foo" 1024 "anotheruser"))) 443 | (should (equal (plist-get result :host) "bar")) 444 | (should (equal (plist-get result :port) 512)) 445 | (should (equal (plist-get result :user) "anuser"))))) 446 | 447 | (ert-deftest auth-source-pass-build-result-with-multiple-hosts () 448 | (auth-source-pass--with-store-find-foo 449 | '(("foo" ("secret" . "foo password"))) 450 | (let ((result (auth-source-pass--build-result '("bar" "foo") 512 "user"))) 451 | (should (equal (plist-get result :host) "foo")) 452 | (should (equal (plist-get result :port) 512)) 453 | (should (equal (plist-get result :user) "user"))))) 454 | 455 | (ert-deftest auth-source-pass-build-result-with-multiple-hosts-no-match () 456 | (auth-source-pass--with-store-find-foo 457 | '(("foo" ("secret" . "foo password"))) 458 | (should-not (auth-source-pass--build-result '("bar" "baz") 512 "user")))) 459 | 460 | (ert-deftest auth-source-pass-can-start-from-auth-source-search () 461 | (auth-source-pass--with-store '(("gitlab.com" ("user" . "someone"))) 462 | (auth-source-pass-enable) 463 | (let ((result (car (auth-source-search :host "gitlab.com")))) 464 | (should (equal (plist-get result :user) "someone")) 465 | (should (equal (plist-get result :host) "gitlab.com"))))) 466 | 467 | (ert-deftest auth-source-pass-prints-meaningful-debug-log () 468 | (auth-source-pass--with-store '() 469 | (auth-source-pass--find-match "gitlab.com" nil nil) 470 | (should (auth-source-pass--have-message-matching 471 | "entries matching hostname=\"gitlab.com\"")) 472 | (should (auth-source-pass--have-message-matching 473 | "corresponding suffixes to search for: .*\"gitlab.com\"")) 474 | (should (auth-source-pass--have-message-matching 475 | "found no entries matching \"gitlab.com\""))) 476 | (auth-source-pass--with-store '(("gitlab.com")) 477 | (auth-source-pass--find-match "gitlab.com" nil nil) 478 | (should (auth-source-pass--have-message-matching 479 | "found 1 entry matching \"gitlab.com\": \"gitlab.com\""))) 480 | (auth-source-pass--with-store '(("a/gitlab.com") ("b/gitlab.com")) 481 | (auth-source-pass--find-match "gitlab.com" nil nil) 482 | (should (auth-source-pass--have-message-matching 483 | "found 2 entries matching \"gitlab.com\": (\"a/gitlab.com\" \"b/gitlab.com\")")))) 484 | 485 | (provide 'auth-source-pass-tests) 486 | 487 | ;;; auth-source-pass-tests.el ends here 488 | --------------------------------------------------------------------------------