From 41ec0c4a28f2c8899097a3d36f0f99ea5c09df4e Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 27 Nov 2015 01:49:29 +0100 Subject: improve makefile add file structure MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- .gitignore | 2 + Makefile | 181 ++++++++++----- doc/info/fdl.texinfo | 505 ++++++++++++++++++++++++++++++++++++++++++ doc/info/passcheck.texinfo | 140 ++++++++++++ info/fdl.texinfo | 505 ------------------------------------------ info/passcheck.texinfo | 140 ------------ passcheck.auto-completion | 8 - passcheck.py | 262 ---------------------- src/passcheck | 262 ++++++++++++++++++++++ src/passcheck.auto-completion | 8 + 10 files changed, 1047 insertions(+), 966 deletions(-) create mode 100644 doc/info/fdl.texinfo create mode 100644 doc/info/passcheck.texinfo delete mode 100644 info/fdl.texinfo delete mode 100644 info/passcheck.texinfo delete mode 100644 passcheck.auto-completion delete mode 100755 passcheck.py create mode 100755 src/passcheck create mode 100644 src/passcheck.auto-completion diff --git a/.gitignore b/.gitignore index a2185e4..15417ae 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ _/ +/bin/ +/obj/ __pycache__/ \#*\# .* diff --git a/Makefile b/Makefile index 0cadcd9..4bf8330 100644 --- a/Makefile +++ b/Makefile @@ -4,107 +4,186 @@ # without any warranty. PREFIX = /usr -DATA = /share BIN = /bin +DATA = /share +BINDIR = $(PREFIX)$(BIN) +DATADIR = $(PREFIX)$(DATA) +INFODIR = $(DATADIR)/info +LICENSEDIR = $(DATADIR)/licenses + PKGNAME = passcheck COMMAND = passcheck -LICENSES = $(PREFIX)$(DATA) -all: command data doc shell +.PHONY: default +default: command data info shell +.PHONY: all +all: command data doc shell -command: passcheck.install +.PHONY: command +command: bin/passcheck -passcheck.install: passcheck.py +bin/passcheck: src/passcheck + @mkdir -p bin cp "$<" "$@" sed -i "s:'blacklist':'$(PREFIX)$(DATA)/misc/$(PKGNAME).blacklist':g" "$@" - +.PHONY: data data: blacklist blacklist: blacklist.lrz @printf '\e[0;1;35m%s\e[0m\n' 'Decompression blacklist.lrz, this can take a very long time (over 1 CPU-hour)' lrzip -d "$<" +.PHONY: doc +doc: info pdf dvi ps -doc: info - +.PHONY: info info: passcheck.info +bin/%.info: doc/info/%.texinfo + @mkdir -p bin + $(MAKEINFO) $< + mv $*.info $@ + +.PHONY: pdf +pdf: bin/passcheck.pdf +bin/%.pdf: doc/info/%.texinfo + @! test -d obj/pdf || rm -rf obj/pdf + @mkdir -p bin obj/pdf + cd obj/pdf && texi2pdf ../../"$<" < /dev/null + mv obj/pdf/$*.pdf $@ + +.PHONY: dvi +dvi: bin/passcheck.dvi +bin/%.dvi: doc/info/%.texinfo + @! test -d obj/dvi || rm -rf obj/dvi + @mkdir -p bin obj/dvi + cd obj/dvi && $(TEXI2DVI) ../../"$<" < /dev/null + mv obj/dvi/$*.dvi $@ + +.PHONY: ps +ps: bin/passcheck.ps +bin/%.ps: doc/info/%.texinfo + @! test -d obj/ps || rm -rf obj/ps + @mkdir -p bin obj/ps + cd obj/ps && texi2pdf --ps ../../"$<" < /dev/null + mv obj/ps/$*.ps $@ + +.PHONY: shell +shell: bash fish zsh -%.info: info/%.texinfo - makeinfo "$<" +.PHONY: bash +bash: bin/passcheck.bash-completion +.PHONY: fish +fish: bin/passcheck.fish-completion -shell: bash fish zsh +.PHONY: zsh +zsh: bin/passcheck.zsh-completion -bash: passcheck.bash-completion -fish: passcheck.fish-completion -zsh: passcheck.zsh-completion +obj/passcheck.auto-completion: src/passcheck.auto-completion + @mkdir -p obj + cp $< $@ + sed -i 's/^(passcheck$$/($(COMMAND)/' $@ -passcheck.auto-completion.install: passcheck.auto-completion - cp "$<" "$@" - sed -i 's/^(passcheck$$/($(COMMAND)/' "$@" +bin/passcheck.%sh-completion: obj/passcheck.auto-completion + @mkdir -p bin + auto-auto-complete $*sh --output $@ --source $< -passcheck.%sh-completion: passcheck.auto-completion.install - auto-auto-complete "$*sh" --output "$@" --source "$<" +.PHONY: install +install: install-cmd install-data install-license install-info install-shell -install: install-cmd install-data install-license install-doc install-shell +.PHONY: install-all +install-all: install-cmd install-data install-license install-doc install-shell -install-cmd: passcheck.install +.PHONY: install-cmd +install-cmd: bin/passcheck install -dm755 -- "$(DESTDIR)$(PREFIX)$(BIN)" - install -m755 passcheck.install -- "$(DESTDIR)$(PREFIX)$(BIN)/$(COMMAND)" + install -m755 $< -- "$(DESTDIR)$(PREFIX)$(BIN)/$(COMMAND)" +.PHONY: install-data install-data: install-blacklist +.PHONY: install-blacklist install-blacklist: blacklist - install -dm755 -- "$(DESTDIR)$(PREFIX)$(DATA)/misc" - install -m644 blacklist -- "$(DESTDIR)$(PREFIX)$(DATA)/misc/$(PKGNAME).blacklist" + install -dm755 -- "$(DESTDIR)$(PREFIX)$(DATADIR)/misc" + install -m644 $< -- "$(DESTDIR)$(DATADIR)/misc/$(PKGNAME).blacklist" +.PHONY: install-license install-license: - install -dm755 -- "$(DESTDIR)$(LICENSES)/$(PKGNAME)" - install -m644 COPYING LICENSE -- "$(DESTDIR)$(LICENSES)/$(PKGNAME)" + install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" + install -m644 COPYING LICENSE -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" +.PHONY: install-doc install-doc: install-info -install-info: passcheck.info - install -dm755 -- "$(DESTDIR)$(PREFIX)$(DATA)/info" - install -m644 passcheck.info -- "$(DESTDIR)$(PREFIX)$(DATA)/info/$(PKGNAME).info" +.PHONY: install-info +install-info: bin/passcheck.info + install -dm755 -- "$(DESTDIR)$(INFODIR)" + install -m644 $< -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" -install-shell: install-bash install-fish install-zsh +.PHONY: install-pdf +install-pdf: bin/passcheck.pdf + install -dm755 -- "$(DESTDIR)$(DOCDIR)" + install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" -install-bash: passcheck.bash-completion - install -Dm644 passcheck.bash-completion -- "$(DESTDIR)$(PREFIX)$(DATA)/bash-completion/completions/$(COMMAND)" +.PHONY: install-dvi +install-dvi: bin/passcheck.dvi + install -dm755 -- "$(DESTDIR)$(DOCDIR)" + install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" -install-fish: passcheck.fish-completion - install -Dm644 passcheck.fish-completion -- "$(DESTDIR)$(PREFIX)$(DATA)/fish/completions/$(COMMAND).fish" +.PHONY: install-ps +install-ps: bin/passcheck.ps + install -dm755 -- "$(DESTDIR)$(DOCDIR)" + install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" -install-zsh: passcheck.zsh-completion - install -Dm644 passcheck.zsh-completion -- "$(DESTDIR)$(PREFIX)$(DATA)/zsh/site-functions/_$(COMMAND)" +.PHONY: install-shell +install-shell: install-bash install-fish install-zsh +.PHONY: install-bash +install-bash: bin/passcheck.bash-completion + install -dm755 -- "$(DESTDIR)$(DATADIR)/bash-completion/completions" + install -dm644 $< -- "$(DESTDIR)$(DATADIR)/bash-completion/completions/$(COMMAND)" +.PHONY: install-fish +install-fish: bin/passcheck.fish-completion + install -dm755 -- "$(DESTDIR)$(DATADIR)/fish/completions" + install -m644 $< -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish" -uninstall: - -rm -- "$(DESTDIR)$(PREFIX)$(BIN)/$(COMMAND)" - -rm -- "$(DESTDIR)$(LICENSES)/$(PKGNAME)/COPYING" - -rm -- "$(DESTDIR)$(LICENSES)/$(PKGNAME)/LICENSE" - -rmdir -- "$(DESTDIR)$(LICENSES)/$(PKGNAME)" - -rm -- "$(DESTDIR)$(PREFIX)$(DATA)/info/$(PKGNAME).info" - -rm -- "$(DESTDIR)$(PREFIX)$(DATA)/bash-completion/completions/$(COMMAND)" - -rm -- "$(DESTDIR)$(PREFIX)$(DATA)/fish/completions/$(COMMAND).fish" - -rm -- "$(DESTDIR)$(PREFIX)$(DATA)/zsh/site-functions/_$(COMMAND)" - -rmdir -- "$(DESTDIR)$(PREFIX)$(DATA)/misc" - -rm -- "$(DESTDIR)$(PREFIX)$(DATA)/misc/$(PKGNAME).blacklist" +.PHONY: install-zsh +install-zsh: bin/passcheck.zsh-completion + install -dm755 -- "$(DESTDIR)$(DATADIR)/zsh/site-functions" + install -m644 $< -- "$(DESTDIR)$(DATADIR)/zsh/site-functions/_$(COMMAND)" +.PHONY: uninstall +uninstall: + -rm -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" + -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/COPYING" + -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE" + -rmdir -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" + -rm -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" + -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" + -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" + -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" + -rm -- "$(DESTDIR)$(DATADIR)/bash-completion/completions/$(COMMAND)" + -rm -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish" + -rm -- "$(DESTDIR)$(DATADIR)/zsh/site-functions/_$(COMMAND)" + -rmdir -- "$(DESTDIR)$(DATADIR)/misc" + -rm -- "$(DESTDIR)$(DATADIR)/misc/$(PKGNAME).blacklist" + + + +.PHONY: clean clean: - -rm -f passcheck.info.gz *.install passcheck.*sh-completion - - + -rm -r bin obj -.PHONY: all command data doc info shell bash fish zsh install install-cmd install-data install-blacklist install-license install-doc install-info install-shell install-bash install-fish install-zsh uninstall clean +.PHONY: distclean +distclean: clean + -rm blacklist blacklist.lrz diff --git a/doc/info/fdl.texinfo b/doc/info/fdl.texinfo new file mode 100644 index 0000000..cb71f05 --- /dev/null +++ b/doc/info/fdl.texinfo @@ -0,0 +1,505 @@ +@c The GNU Free Documentation License. +@center Version 1.3, 3 November 2008 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +@uref{http://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{free} in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The ``publisher'' means any person or entity that distributes copies +of the Document to the public. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled ``History'' +in the various original documents, forming one section Entitled +``History''; likewise combine any sections Entitled ``Acknowledgements'', +and any sections Entitled ``Dedications''. You must delete all +sections Entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{http://www.gnu.org/copyleft/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +@item +RELICENSING + +``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +site means any set of copyrightable works thus published on the MMC +site. + +``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +``Incorporate'' means to publish or republish a Document, in whole or +in part, as part of another Document. + +An MMC is ``eligible for relicensing'' if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.''@: line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: diff --git a/doc/info/passcheck.texinfo b/doc/info/passcheck.texinfo new file mode 100644 index 0000000..4f9abbf --- /dev/null +++ b/doc/info/passcheck.texinfo @@ -0,0 +1,140 @@ +\input texinfo @c -*-texinfo-*- + +@c %**start of header +@setfilename passcheck.info +@settitle passcheck +@afourpaper +@documentencoding UTF-8 +@documentlanguage en +@finalout +@c %**end of header + + +@dircategory Security +@direntry +* passcheck: (passcheck). Passphrase strength evaluator +@end direntry + + +@copying +Copyright @copyright{} 2013, 2015 Mattias Andrée + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts, and with no Back-Cover +Texts. A copy of the license is included in the section entitled +``GNU Free Documentation License''. +@end quotation +@end copying + +@ifnottex +@node Top +@top passcheck -- Passphrase strength evaluator +@insertcopying +@end ifnottex + +@titlepage +@title passcheck +@subtitle Passphrase strength evaluator +@author by Mattias Andrée (maandree) + +@page +@vskip 0pt plus 1filll +@insertcopying +@page +@end titlepage + +@contents + + + +@menu +* Overview:: Brief overview of @command{passcheck}. +* Invoking:: Executing @command{passcheck}. +* Factors:: Factors weighted in at evaulation. +* GNU Free Documentation License:: Copying and sharing this manual. +@end menu + + + +@node Overview +@chapter Overview + +@command{passcheck} is a tool that rates passphrases based on the strengths, +a highly rated passphrase is a string passphrase. You are recommended not to +use any passphrases rated below 300. + +Passphrases are read from stdin and the rating followed by the passphrase +for each passphrases is written to stdout, and stderr is quited unless the +program files. + + + +@node Invoking +@chapter Invoking + +@command{passcheck} parses each line (must end exactly with one UNIX line break) +as a passphrase and puts the (positive integer) rating before the passphrase +separated with one blankspace. + +You may want to pipe stdout to @command{sort -n} to get the strongest passphrase +at the bottom. + +Use @option{--raw} or @option{-r} if the passphrase may contain a ESC character, +otherwise it is parsed as an ANSI escape sequence which is ignored in the rating +and allows you to use colours in the passphrases. + +Server with vast amount of RAM memory may want to load the entire blacklist +into RAM and create a hash set of it. To do this, use @option{--waste-ram} or +@option{-w}. It is unreasonable to do this unless you have the process running +indefinitely and (somewhat) continuously feed passphrases. + + + +@node Factors +@chapter Factors + +@command{passcheck} weights in the following factors when evaluating +the strength of a passphrase: +@itemize @bullet +@item +The passphrase is not a known real passphrase. +Currently a list of 5189414 leaked passphrases is is used. +This list is created from several password leaks, name +lists, and dictionaries. +@item +The passphrase is not a word listed in a file +inside either ofthe directory @file{/usr/share/dict/} +abd @file{/usr/local/share/dict/}. +@item +The degree to which characters are mixed. +@item +The classes of used characters. For example non-ASCII +characters are better than ASCII chracters. +@item +The distance, on a QWERTY-keyboard, of successive keys. +@item +The length of the passphrase. +@end itemize + +It has been argued that passphrases should not form grammatically +correct sentence, even if the sentence itself if nonsense. The argument +is that the majority of possible choices of words can be eliminated for +each word position, based on the previous word. However a counterargument +for this concern is that number of possible combinations, assuming the +sentence is nonsensical, large enough even if choices can be eliminated +using grammar. Currently, evaluation based on grammar is not made, so if +you believe grammatically correct sentence should be avoided, please +manually check that the passphrase you choose does not form a grammatically +correct sentence, and preferably, not even in part. + + + +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include fdl.texinfo + +@bye + diff --git a/info/fdl.texinfo b/info/fdl.texinfo deleted file mode 100644 index cb71f05..0000000 --- a/info/fdl.texinfo +++ /dev/null @@ -1,505 +0,0 @@ -@c The GNU Free Documentation License. -@center Version 1.3, 3 November 2008 - -@c This file is intended to be included within another document, -@c hence no sectioning command or @node. - -@display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. -@uref{http://fsf.org/} - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -@end display - -@enumerate 0 -@item -PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document @dfn{free} in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of ``copyleft'', which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - -@item -APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The ``Document'', below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as ``you''. You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A ``Modified Version'' of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A ``Secondary Section'' is a named appendix or a front-matter section -of the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The ``Invariant Sections'' are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The ``Cover Texts'' are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A ``Transparent'' copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not ``Transparent'' is called ``Opaque''. - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, La@TeX{} input -format, SGML or XML using a publicly available -DTD, and standard-conforming simple HTML, -PostScript or PDF designed for human modification. Examples -of transparent image formats include PNG, XCF and -JPG. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, SGML or -XML for which the DTD and/or processing tools are -not generally available, and the machine-generated HTML, -PostScript or PDF produced by some word processors for -output purposes only. - -The ``Title Page'' means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, ``Title Page'' means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -The ``publisher'' means any person or entity that distributes copies -of the Document to the public. - -A section ``Entitled XYZ'' means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as ``Acknowledgements'', -``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' -of such a section when you modify the Document means that it remains a -section ``Entitled XYZ'' according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - -@item -VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - -@item -COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. - -@item -MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -@enumerate A -@item -Use in the Title Page (and on the covers, if any) a title distinct -from that of the Document, and from those of previous versions -(which should, if there were any, be listed in the History section -of the Document). You may use the same title as a previous version -if the original publisher of that version gives permission. - -@item -List on the Title Page, as authors, one or more persons or entities -responsible for authorship of the modifications in the Modified -Version, together with at least five of the principal authors of the -Document (all of its principal authors, if it has fewer than five), -unless they release you from this requirement. - -@item -State on the Title page the name of the publisher of the -Modified Version, as the publisher. - -@item -Preserve all the copyright notices of the Document. - -@item -Add an appropriate copyright notice for your modifications -adjacent to the other copyright notices. - -@item -Include, immediately after the copyright notices, a license notice -giving the public permission to use the Modified Version under the -terms of this License, in the form shown in the Addendum below. - -@item -Preserve in that license notice the full lists of Invariant Sections -and required Cover Texts given in the Document's license notice. - -@item -Include an unaltered copy of this License. - -@item -Preserve the section Entitled ``History'', Preserve its Title, and add -to it an item stating at least the title, year, new authors, and -publisher of the Modified Version as given on the Title Page. If -there is no section Entitled ``History'' in the Document, create one -stating the title, year, authors, and publisher of the Document as -given on its Title Page, then add an item describing the Modified -Version as stated in the previous sentence. - -@item -Preserve the network location, if any, given in the Document for -public access to a Transparent copy of the Document, and likewise -the network locations given in the Document for previous versions -it was based on. These may be placed in the ``History'' section. -You may omit a network location for a work that was published at -least four years before the Document itself, or if the original -publisher of the version it refers to gives permission. - -@item -For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve -the Title of the section, and preserve in the section all the -substance and tone of each of the contributor acknowledgements and/or -dedications given therein. - -@item -Preserve all the Invariant Sections of the Document, -unaltered in their text and in their titles. Section numbers -or the equivalent are not considered part of the section titles. - -@item -Delete any section Entitled ``Endorsements''. Such a section -may not be included in the Modified Version. - -@item -Do not retitle any existing section to be Entitled ``Endorsements'' or -to conflict in title with any Invariant Section. - -@item -Preserve any Warranty Disclaimers. -@end enumerate - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled ``Endorsements'', provided it contains -nothing but endorsements of your Modified Version by various -parties---for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - -@item -COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled ``History'' -in the various original documents, forming one section Entitled -``History''; likewise combine any sections Entitled ``Acknowledgements'', -and any sections Entitled ``Dedications''. You must delete all -sections Entitled ``Endorsements.'' - -@item -COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. - -You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. - -@item -AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an ``aggregate'' if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - -@item -TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled ``Acknowledgements'', -``Dedications'', or ``History'', the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - -@item -TERMINATION - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. - -@item -FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. See -@uref{http://www.gnu.org/copyleft/}. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License ``or any later version'' applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy's public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. - -@item -RELICENSING - -``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any -World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the -site means any set of copyrightable works thus published on the MMC -site. - -``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. - -``Incorporate'' means to publish or republish a Document, in whole or -in part, as part of another Document. - -An MMC is ``eligible for relicensing'' if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole -or in part into the MMC, (1) had no cover texts or invariant sections, -and (2) were thus incorporated prior to November 1, 2008. - -The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. - -@end enumerate - -@page -@heading ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - -@smallexample -@group - Copyright (C) @var{year} @var{your name}. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. -@end group -@end smallexample - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.''@: line with this: - -@smallexample -@group - with the Invariant Sections being @var{list their titles}, with - the Front-Cover Texts being @var{list}, and with the Back-Cover Texts - being @var{list}. -@end group -@end smallexample - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. - -@c Local Variables: -@c ispell-local-pdict: "ispell-dict" -@c End: diff --git a/info/passcheck.texinfo b/info/passcheck.texinfo deleted file mode 100644 index 4f9abbf..0000000 --- a/info/passcheck.texinfo +++ /dev/null @@ -1,140 +0,0 @@ -\input texinfo @c -*-texinfo-*- - -@c %**start of header -@setfilename passcheck.info -@settitle passcheck -@afourpaper -@documentencoding UTF-8 -@documentlanguage en -@finalout -@c %**end of header - - -@dircategory Security -@direntry -* passcheck: (passcheck). Passphrase strength evaluator -@end direntry - - -@copying -Copyright @copyright{} 2013, 2015 Mattias Andrée - -@quotation -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license is included in the section entitled -``GNU Free Documentation License''. -@end quotation -@end copying - -@ifnottex -@node Top -@top passcheck -- Passphrase strength evaluator -@insertcopying -@end ifnottex - -@titlepage -@title passcheck -@subtitle Passphrase strength evaluator -@author by Mattias Andrée (maandree) - -@page -@vskip 0pt plus 1filll -@insertcopying -@page -@end titlepage - -@contents - - - -@menu -* Overview:: Brief overview of @command{passcheck}. -* Invoking:: Executing @command{passcheck}. -* Factors:: Factors weighted in at evaulation. -* GNU Free Documentation License:: Copying and sharing this manual. -@end menu - - - -@node Overview -@chapter Overview - -@command{passcheck} is a tool that rates passphrases based on the strengths, -a highly rated passphrase is a string passphrase. You are recommended not to -use any passphrases rated below 300. - -Passphrases are read from stdin and the rating followed by the passphrase -for each passphrases is written to stdout, and stderr is quited unless the -program files. - - - -@node Invoking -@chapter Invoking - -@command{passcheck} parses each line (must end exactly with one UNIX line break) -as a passphrase and puts the (positive integer) rating before the passphrase -separated with one blankspace. - -You may want to pipe stdout to @command{sort -n} to get the strongest passphrase -at the bottom. - -Use @option{--raw} or @option{-r} if the passphrase may contain a ESC character, -otherwise it is parsed as an ANSI escape sequence which is ignored in the rating -and allows you to use colours in the passphrases. - -Server with vast amount of RAM memory may want to load the entire blacklist -into RAM and create a hash set of it. To do this, use @option{--waste-ram} or -@option{-w}. It is unreasonable to do this unless you have the process running -indefinitely and (somewhat) continuously feed passphrases. - - - -@node Factors -@chapter Factors - -@command{passcheck} weights in the following factors when evaluating -the strength of a passphrase: -@itemize @bullet -@item -The passphrase is not a known real passphrase. -Currently a list of 5189414 leaked passphrases is is used. -This list is created from several password leaks, name -lists, and dictionaries. -@item -The passphrase is not a word listed in a file -inside either ofthe directory @file{/usr/share/dict/} -abd @file{/usr/local/share/dict/}. -@item -The degree to which characters are mixed. -@item -The classes of used characters. For example non-ASCII -characters are better than ASCII chracters. -@item -The distance, on a QWERTY-keyboard, of successive keys. -@item -The length of the passphrase. -@end itemize - -It has been argued that passphrases should not form grammatically -correct sentence, even if the sentence itself if nonsense. The argument -is that the majority of possible choices of words can be eliminated for -each word position, based on the previous word. However a counterargument -for this concern is that number of possible combinations, assuming the -sentence is nonsensical, large enough even if choices can be eliminated -using grammar. Currently, evaluation based on grammar is not made, so if -you believe grammatically correct sentence should be avoided, please -manually check that the passphrase you choose does not form a grammatically -correct sentence, and preferably, not even in part. - - - -@node GNU Free Documentation License -@appendix GNU Free Documentation License -@include fdl.texinfo - -@bye - diff --git a/passcheck.auto-completion b/passcheck.auto-completion deleted file mode 100644 index 40e34ae..0000000 --- a/passcheck.auto-completion +++ /dev/null @@ -1,8 +0,0 @@ -(passcheck - (unargumented (options -r --raw) (complete --raw) - (desc 'Treat escape sequences as part of the passphrases')) - - (unargumented (options -w --waste-ram) (complete --waste-ram) - (desc 'Load the data blacklist and create a hashtable')) -) - diff --git a/passcheck.py b/passcheck.py deleted file mode 100755 index ab3f323..0000000 --- a/passcheck.py +++ /dev/null @@ -1,262 +0,0 @@ -#!/usr/bin/env python -# -# passcheck – passphrase strenght evaluator -# -# Copyright © 2013, 2015 Mattias Andrée (maandree@member.fsf.org) -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version, or under the terms of the New BSD -# License as published by the Regents of the University of California. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . -# - -import sys -import os - - -def _class(char): - char = ord(char) - if ord('0') <= char <= ord('9'): - return 1 - elif ord('a') <= char <= ord('z'): - return 2 - elif ord('A') <= char <= ord('Z'): - return 2.5 - elif char < (1 << 7): - return 3 - elif char < (1 << 8): - return 3.5 - elif char < (1 << 10): - return 4 - elif char < (1 << 14): - return 5 - elif char < (1 << 16): - return 6 - elif char < (1 << 18): - return 7 - elif char < (1 << 22): - return 8 - elif char < (1 << 26): - return 9 - else: - return 10 - - -def distance(a, b): - a, b = a.lower(), b.lower() - if a == b: - return 0 - L1 = '1234567890' - L2 = 'qwertyuiop' - L3 = 'asdfghjkl' - L4 = 'zxcvbnm' - keys = {} - for x in range(len(L1)): - keys[L1[x]] = (x, 0) - for x in range(len(L2)): - keys[L2[x]] = (x + 0.5, 1) - for x in range(len(L3)): - keys[L3[x]] = (x + 0.75, 2) - for x in range(len(L4)): - keys[L4[x]] = (x + 1, 3) - for c in (a, b): - if c not in keys: - return 15 - return ((keys[a][0] - keys[b][0]) ** 2 + (keys[a][1] - keys[b][1]) ** 2) ** 0.5 - - -def search_cmp(haystack, needle): - haystack = haystack + [10] - h, n = 0, 0 - too_low = False - too_high = False - while True: - while True: - hh, nn = haystack[h], needle[n] - if (hh == 10) or (nn == 10): - if hh == nn: - return 0 - break - else: - d = hh - nn - if d != 0: - if d < 0: - too_low = True - break - else: - return None if too_low else 1 - h, n = h + 1, n + 1 - h, n = h + haystack[h:].index(10) + 1, 0 - too_low = too_low or (hh == 10) - too_high = too_high or (nn == 10) - if h == len(haystack): - return None if (too_low and too_high) else (-1 if too_low else 1) - -def pread_full(fd, bs, offset, output): - got_total = 0 - while got_total < bs: - got = list(os.pread(fd, bs - got_total, offset + got_total)) - if len(got) == 0: - break - got_total += len(got) - output.extend(got) - -def search_file(fd, filesize, passphrase): - blocksize = 4096 - minimum = 0 - maximum = filesize - 1 - passphrase = passphrase + [10] - while minimum <= maximum: - middle = (minimum + maximum) // 2 - middle -= middle % blocksize - middle_low = None - continues = 0 - data = [] - while True: - pread_full(fd, blocksize, middle + continues * blocksize, data) - if middle_low is None: - middle_low = 0 - if middle > 0: - try: - middle_low = data.index(10) - except ValueError: - middle_low = None - continue - if middle + len(data) >= filesize: - middle_high = len(data) - else: - middle_high = len(data) - 1 - while (middle_high > middle_low) and (data[middle_high] != 10): - middle_high -= 1 - if middle_high <= middle_low: - continue - if middle > 0: - middle_low += 1 - break - v = search_cmp(data[middle_low : middle_high], passphrase) - if v is None: - return False - elif v < 0: - minimum = middle + middle_low + 1 - elif v > 0: - maximum = middle + middle_high - else: - return True - return False - - -def evaluate(data): - rc = 0 - last = None - data = bytes(data).decode('utf-8', 'replace') - used = {} - classes = [0] * 12 - for c in data: - r = _class(c) - if c not in used: - used[c] = 1 - else: - used[c] += 1 - rc += r ** 2 - rc += 5 / used[c] - if r >= 4: - r += 2 - elif r > 3: - r = 5 - elif r == 3: - r = 4 - elif r > 2: - r = 3 - classes[r - 1] += 1 - if last is not None: - r = distance(c, last) - rc += r ** 0.5 - last = c - if rc >= 0: - rc += 30 - (a, b, c, d) = classes[:4] - if a + b + c + d == 0: - rc += 30 - else: - r = a ** 2 + b ** 2 + c ** 2 + d ** 2 - rc += 30 * len(data) / (r ** 0.5) - return (rc + 0.5) // 1 - - - -waste_ram = ('--waste-ram' in sys.argv[1:]) or ('-w' in sys.argv[1:]) -raw = ('--raw' in sys.argv[1:]) or ('-r' in sys.argv[1:]) - - -blacklist_files = [] -if waste_ram: - try: - with open('blacklist', 'rb') as file: - blacklist = set(file.read().decode('utf-8', 'replace').split('\n')) - except FileNotFoundError: - sys.stderr.write('File "blacklist" from the git branch "large-files" is not present.\n'); - sys.exit(1) -else: - blacklist = set([]) - fd = os.open('blacklist', os.O_RDONLY) - blacklist_files.append((fd, os.fstat(fd).st_size)) -for directory in ['/usr/share/dict/', '/usr/local/share/dict/']: - dictionaries = None - try: - dictionaries = os.listdir(directory) - except FileNotFoundError: - pass - if dictionaries is not None: - for dictionary in dictionaries: - if not os.path.isdir(directory + dictionary): - with open(directory + dictionary, 'rb') as file: - blacklist.update(set(file.read().decode('utf-8', 'replace').split('\n'))) - - -while True: - line = [] - try: - while True: - c = sys.stdin.buffer.read(1)[0] - if c == 10: - break - line.append(c) - except: - break - passphrase = [] - if raw: - passphrase = line - else: - escape = False - for c in line: - if escape: - if (c == ord('~')) or (ord('a') <= c <= ord('z')) or (ord('A') <= c <= ord('Z')): - escape = False - elif c == ord('\033'): - escape = True - else: - passphrase.append(c) - rating = None - if ''.join([chr(c) for c in passphrase]) in blacklist: - rating = 0 - else: - for fd, filesize in blacklist_files: - if search_file(fd, filesize, passphrase): - rating = 0 - break - if rating is None: - rating = evaluate(passphrase) - sys.stdout.buffer.write(('%i \033[34m' % rating).encode('utf-8')) - sys.stdout.buffer.write(bytes(line)) - sys.stdout.buffer.write('\033[00m\n'.encode('utf-8')) - sys.stdout.buffer.flush() - diff --git a/src/passcheck b/src/passcheck new file mode 100755 index 0000000..ab3f323 --- /dev/null +++ b/src/passcheck @@ -0,0 +1,262 @@ +#!/usr/bin/env python +# +# passcheck – passphrase strenght evaluator +# +# Copyright © 2013, 2015 Mattias Andrée (maandree@member.fsf.org) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version, or under the terms of the New BSD +# License as published by the Regents of the University of California. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# + +import sys +import os + + +def _class(char): + char = ord(char) + if ord('0') <= char <= ord('9'): + return 1 + elif ord('a') <= char <= ord('z'): + return 2 + elif ord('A') <= char <= ord('Z'): + return 2.5 + elif char < (1 << 7): + return 3 + elif char < (1 << 8): + return 3.5 + elif char < (1 << 10): + return 4 + elif char < (1 << 14): + return 5 + elif char < (1 << 16): + return 6 + elif char < (1 << 18): + return 7 + elif char < (1 << 22): + return 8 + elif char < (1 << 26): + return 9 + else: + return 10 + + +def distance(a, b): + a, b = a.lower(), b.lower() + if a == b: + return 0 + L1 = '1234567890' + L2 = 'qwertyuiop' + L3 = 'asdfghjkl' + L4 = 'zxcvbnm' + keys = {} + for x in range(len(L1)): + keys[L1[x]] = (x, 0) + for x in range(len(L2)): + keys[L2[x]] = (x + 0.5, 1) + for x in range(len(L3)): + keys[L3[x]] = (x + 0.75, 2) + for x in range(len(L4)): + keys[L4[x]] = (x + 1, 3) + for c in (a, b): + if c not in keys: + return 15 + return ((keys[a][0] - keys[b][0]) ** 2 + (keys[a][1] - keys[b][1]) ** 2) ** 0.5 + + +def search_cmp(haystack, needle): + haystack = haystack + [10] + h, n = 0, 0 + too_low = False + too_high = False + while True: + while True: + hh, nn = haystack[h], needle[n] + if (hh == 10) or (nn == 10): + if hh == nn: + return 0 + break + else: + d = hh - nn + if d != 0: + if d < 0: + too_low = True + break + else: + return None if too_low else 1 + h, n = h + 1, n + 1 + h, n = h + haystack[h:].index(10) + 1, 0 + too_low = too_low or (hh == 10) + too_high = too_high or (nn == 10) + if h == len(haystack): + return None if (too_low and too_high) else (-1 if too_low else 1) + +def pread_full(fd, bs, offset, output): + got_total = 0 + while got_total < bs: + got = list(os.pread(fd, bs - got_total, offset + got_total)) + if len(got) == 0: + break + got_total += len(got) + output.extend(got) + +def search_file(fd, filesize, passphrase): + blocksize = 4096 + minimum = 0 + maximum = filesize - 1 + passphrase = passphrase + [10] + while minimum <= maximum: + middle = (minimum + maximum) // 2 + middle -= middle % blocksize + middle_low = None + continues = 0 + data = [] + while True: + pread_full(fd, blocksize, middle + continues * blocksize, data) + if middle_low is None: + middle_low = 0 + if middle > 0: + try: + middle_low = data.index(10) + except ValueError: + middle_low = None + continue + if middle + len(data) >= filesize: + middle_high = len(data) + else: + middle_high = len(data) - 1 + while (middle_high > middle_low) and (data[middle_high] != 10): + middle_high -= 1 + if middle_high <= middle_low: + continue + if middle > 0: + middle_low += 1 + break + v = search_cmp(data[middle_low : middle_high], passphrase) + if v is None: + return False + elif v < 0: + minimum = middle + middle_low + 1 + elif v > 0: + maximum = middle + middle_high + else: + return True + return False + + +def evaluate(data): + rc = 0 + last = None + data = bytes(data).decode('utf-8', 'replace') + used = {} + classes = [0] * 12 + for c in data: + r = _class(c) + if c not in used: + used[c] = 1 + else: + used[c] += 1 + rc += r ** 2 + rc += 5 / used[c] + if r >= 4: + r += 2 + elif r > 3: + r = 5 + elif r == 3: + r = 4 + elif r > 2: + r = 3 + classes[r - 1] += 1 + if last is not None: + r = distance(c, last) + rc += r ** 0.5 + last = c + if rc >= 0: + rc += 30 + (a, b, c, d) = classes[:4] + if a + b + c + d == 0: + rc += 30 + else: + r = a ** 2 + b ** 2 + c ** 2 + d ** 2 + rc += 30 * len(data) / (r ** 0.5) + return (rc + 0.5) // 1 + + + +waste_ram = ('--waste-ram' in sys.argv[1:]) or ('-w' in sys.argv[1:]) +raw = ('--raw' in sys.argv[1:]) or ('-r' in sys.argv[1:]) + + +blacklist_files = [] +if waste_ram: + try: + with open('blacklist', 'rb') as file: + blacklist = set(file.read().decode('utf-8', 'replace').split('\n')) + except FileNotFoundError: + sys.stderr.write('File "blacklist" from the git branch "large-files" is not present.\n'); + sys.exit(1) +else: + blacklist = set([]) + fd = os.open('blacklist', os.O_RDONLY) + blacklist_files.append((fd, os.fstat(fd).st_size)) +for directory in ['/usr/share/dict/', '/usr/local/share/dict/']: + dictionaries = None + try: + dictionaries = os.listdir(directory) + except FileNotFoundError: + pass + if dictionaries is not None: + for dictionary in dictionaries: + if not os.path.isdir(directory + dictionary): + with open(directory + dictionary, 'rb') as file: + blacklist.update(set(file.read().decode('utf-8', 'replace').split('\n'))) + + +while True: + line = [] + try: + while True: + c = sys.stdin.buffer.read(1)[0] + if c == 10: + break + line.append(c) + except: + break + passphrase = [] + if raw: + passphrase = line + else: + escape = False + for c in line: + if escape: + if (c == ord('~')) or (ord('a') <= c <= ord('z')) or (ord('A') <= c <= ord('Z')): + escape = False + elif c == ord('\033'): + escape = True + else: + passphrase.append(c) + rating = None + if ''.join([chr(c) for c in passphrase]) in blacklist: + rating = 0 + else: + for fd, filesize in blacklist_files: + if search_file(fd, filesize, passphrase): + rating = 0 + break + if rating is None: + rating = evaluate(passphrase) + sys.stdout.buffer.write(('%i \033[34m' % rating).encode('utf-8')) + sys.stdout.buffer.write(bytes(line)) + sys.stdout.buffer.write('\033[00m\n'.encode('utf-8')) + sys.stdout.buffer.flush() + diff --git a/src/passcheck.auto-completion b/src/passcheck.auto-completion new file mode 100644 index 0000000..40e34ae --- /dev/null +++ b/src/passcheck.auto-completion @@ -0,0 +1,8 @@ +(passcheck + (unargumented (options -r --raw) (complete --raw) + (desc 'Treat escape sequences as part of the passphrases')) + + (unargumented (options -w --waste-ram) (complete --waste-ram) + (desc 'Load the data blacklist and create a hashtable')) +) + -- cgit v1.2.3-70-g09d2