diff --git a/CMakeModules/FindLibPWQuality.cmake b/CMakeModules/FindLibPWQuality.cmake new file mode 100644 index 000000000..84136f5ad --- /dev/null +++ b/CMakeModules/FindLibPWQuality.cmake @@ -0,0 +1,37 @@ +# Locate libpwquality +# https://github.com/libpwquality/libpwquality +# +# This module defines +# LibPWQuality_FOUND +# LibPWQuality_LIBRARIES, where to find the library +# LibPWQuality_INCLUDE_DIRS, where to find pwquality.h +# +include(FindPkgConfig) +include(FindPackageHandleStandardArgs) + +pkg_search_module(pc_pwquality QUIET pwquality) + +find_path(LibPWQuality_INCLUDE_DIR + NAMES pwquality.h + PATHS ${pc_pwquality_INCLUDE_DIRS} +) +find_library(LibPWQuality_LIBRARY + NAMES pwquality + PATHS ${pc_pwquality_LIBRARY_DIRS} +) +if(pc_pwquality_FOUND) + set(LibPWQuality_LIBRARIES ${LibPWQuality_LIBRARY}) + set(LibPWQuality_INCLUDE_DIRS ${LibPWQuality_INCLUDE_DIR} ${pc_pwquality_INCLUDE_DIRS}) +endif() + +find_package_handle_standard_args(LibPWQuality DEFAULT_MSG + LibPWQuality_INCLUDE_DIRS + LibPWQuality_LIBRARIES +) +mark_as_advanced(LibPWQuality_INCLUDE_DIRS LibPWQuality_LIBRARIES) + +set_package_properties( + LibPWQuality PROPERTIES + DESCRIPTION "Password quality checking library" + URL "https://github.com/libpwquality/libpwquality" +) diff --git a/LICENSES/GPLv2+-libpwquality b/LICENSES/GPLv2+-libpwquality new file mode 100644 index 000000000..5d1984656 --- /dev/null +++ b/LICENSES/GPLv2+-libpwquality @@ -0,0 +1,383 @@ +Unless otherwise *explicitly* stated the following text describes the +licensed conditions under which the contents of this libpwquality release +may be distributed: + +------------------------------------------------------------------------- +Redistribution and use in source and binary forms of libpwquality, with +or without modification, are permitted provided that the following +conditions are met: + +1. Redistributions of source code must retain any existing copyright + notice, and this entire permission notice in its entirety, + including the disclaimer of warranties. + +2. Redistributions in binary form must reproduce all prior and current + copyright notices, this list of conditions, and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +3. The name of any author may not be used to endorse or promote + products derived from this software without their specific prior + written permission. + +ALTERNATIVELY, this product may be distributed under the terms of the +GNU General Public License version 2 or later, in which case the provisions +of the GNU GPL are required INSTEAD OF the above restrictions. + +THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR +TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE +USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. + +The full text of the GNU GENERAL PUBLIC LICENSE Version 2 is included +below. + +------------------------------------------------------------------------- + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/src/modules/users/CMakeLists.txt b/src/modules/users/CMakeLists.txt index ebff9df8c..16e235fd5 100644 --- a/src/modules/users/CMakeLists.txt +++ b/src/modules/users/CMakeLists.txt @@ -6,6 +6,21 @@ endif() find_package( Qt5 COMPONENTS Core Test REQUIRED ) find_package( Crypt REQUIRED ) +# Add optional libraries here +set( USER_EXTRA_LIB ) + +find_package( LibPWQuality ) +set_package_properties( + LibPWQuality PROPERTIES + PURPOSE "Extra checks of password quality" +) + +if( LibPWQuality_FOUND ) + list( APPEND USER_EXTRA_LIB ${LibPWQuality_LIBRARIES} ) + include_directories( ${LibPWQuality_INCLUDE_DIRS} ) + add_definitions( -DCHECK_PWQUALITY -DHAVE_LIBPWQUALITY ) +endif() + include_directories( ${PROJECT_BINARY_DIR}/src/libcalamaresui ) calamares_add_plugin( users @@ -17,6 +32,7 @@ calamares_add_plugin( users UsersViewStep.cpp UsersPage.cpp SetHostNameJob.cpp + CheckPWQuality.cpp UI page_usersetup.ui RESOURCES @@ -24,6 +40,7 @@ calamares_add_plugin( users LINK_PRIVATE_LIBRARIES calamaresui ${CRYPT_LIBRARIES} + ${USER_EXTRA_LIB} SHARED_LIB ) diff --git a/src/modules/users/CheckPWQuality.cpp b/src/modules/users/CheckPWQuality.cpp new file mode 100644 index 000000000..f8f49a0b1 --- /dev/null +++ b/src/modules/users/CheckPWQuality.cpp @@ -0,0 +1,347 @@ +/* === This file is part of Calamares - === + * + * Copyright 2018, Adriaan de Groot + * + * Calamares is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Calamares is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Calamares. If not, see . + */ + +#include "CheckPWQuality.h" + +#include "utils/Logger.h" + +#include +#include + +#ifdef HAVE_LIBPWQUALITY +#include +#endif + +#include + +static void _default_cleanup() +{ +} + +PasswordCheck::PasswordCheck() + : m_message() + , m_accept( []( const QString& s ){ return true; } ) +{ +} + +PasswordCheck::PasswordCheck( const QString& m, AcceptFunc a ) + : m_message( [m](){ return m; } ) + , m_accept( a ) +{ +} + +PasswordCheck::PasswordCheck( MessageFunc m, AcceptFunc a ) + : m_message( m ) + , m_accept( a ) +{ +} + +// Try to trick Transifex into accepting these strings +#define tr parent->tr +struct LengthExplainer +{ + static QString too_short( QWidget* parent ) + { + return tr( "Password is too short" ); + } + + static QString too_long( QWidget* parent ) + { + return tr( "Password is too long" ); + } +} ; +#undef tr + +DEFINE_CHECK_FUNC( minLength ) +{ + int minLength = -1; + if ( value.canConvert( QVariant::Int ) ) + minLength = value.toInt(); + if ( minLength > 0 ) + { + cDebug() << " .. minLength set to" << minLength; + checks.push_back( + PasswordCheck( + [parent]() + { + return LengthExplainer::too_short( parent ); + }, + [minLength]( const QString& s ) + { + return s.length() >= minLength; + } + ) ); + } +} + +DEFINE_CHECK_FUNC( maxLength ) +{ + int maxLength = -1; + if ( value.canConvert( QVariant::Int ) ) + maxLength = value.toInt(); + if ( maxLength > 0 ) + { + cDebug() << " .. maxLength set to" << maxLength; + checks.push_back( + PasswordCheck( + [parent]() + { + return LengthExplainer::too_long( parent ); + }, + [maxLength]( const QString& s ) + { + return s.length() <= maxLength; + } + ) ); + } +} + +#ifdef HAVE_LIBPWQUALITY +/** + * Class that acts as a RAII placeholder for pwquality_settings_t pointers. + * Gets a new pointer and ensures it is deleted only once; provides + * convenience functions for setting options and checking passwords. + */ +class PWSettingsHolder +{ +public: + static constexpr int arbitrary_minimum_strength = 40; + + PWSettingsHolder() + : m_settings( pwquality_default_settings() ) + , m_auxerror( nullptr ) + { + } + + ~PWSettingsHolder() + { + cDebug() << "Freeing PWQ@" << ( void* )m_settings; + pwquality_free_settings( m_settings ); + } + + /// Sets an option via the configuration string @p v, = style. + int set( const QString& v ) + { + return pwquality_set_option( m_settings, v.toUtf8().constData() ); + } + + /// Checks the given password @p pwd against the current configuration + int check( const QString& pwd ) + { + void* auxerror = nullptr; + int r = pwquality_check( m_settings, pwd.toUtf8().constData(), nullptr, nullptr, &auxerror ); + m_rv = r; + return r; + } + + bool hasExplanation() const + { + return m_rv < 0; + } + +#define tr parent->tr + /* This is roughly the same as the function pwquality_strerror, + * only with QStrings instead, and using the Qt translation scheme. + * It is used under the terms of the GNU GPL v3 or later, as + * allowed by the libpwquality license (LICENSES/GPLv2+-libpwquality) + */ + QString explanation( QWidget* parent ) + { + void* auxerror = m_auxerror; + m_auxerror = nullptr; + + if ( m_rv >= arbitrary_minimum_strength ) + return QString(); + if ( m_rv >= 0 ) + return tr( "Password is too weak" ); + + switch ( m_rv ) + { + case PWQ_ERROR_MEM_ALLOC: + if ( auxerror ) + { + QString s = tr( "Memory allocation error when setting '%1'" ).arg( ( const char* )auxerror ); + free( auxerror ); + return s; + } + return tr( "Memory allocation error" ); + case PWQ_ERROR_SAME_PASSWORD: + return tr( "The password is the same as the old one" ); + case PWQ_ERROR_PALINDROME: + return tr( "The password is a palindrome" ); + case PWQ_ERROR_CASE_CHANGES_ONLY: + return tr( "The password differs with case changes only" ); + case PWQ_ERROR_TOO_SIMILAR: + return tr( "The password is too similar to the old one" ); + case PWQ_ERROR_USER_CHECK: + return tr( "The password contains the user name in some form" ); + case PWQ_ERROR_GECOS_CHECK: + return tr( "The password contains words from the real name of the user in some form" ); + case PWQ_ERROR_BAD_WORDS: + return tr( "The password contains forbidden words in some form" ); + case PWQ_ERROR_MIN_DIGITS: + if ( auxerror ) + return tr( "The password contains less than %1 digits" ).arg( ( long )auxerror ); + return tr( "The password contains too few digits" ); + case PWQ_ERROR_MIN_UPPERS: + if ( auxerror ) + return tr( "The password contains less than %1 uppercase letters" ).arg( ( long )auxerror ); + return tr( "The password contains too few uppercase letters" ); + case PWQ_ERROR_MIN_LOWERS: + if ( auxerror ) + return tr( "The password contains less than %1 lowercase letters" ).arg( ( long )auxerror ); + return tr( "The password contains too few lowercase letters" ); + case PWQ_ERROR_MIN_OTHERS: + if ( auxerror ) + return tr( "The password contains less than %1 non-alphanumeric characters" ).arg( ( long )auxerror ); + return tr( "The password contains too few non-alphanumeric characters" ); + case PWQ_ERROR_MIN_LENGTH: + if ( auxerror ) + return tr( "The password is shorter than %1 characters" ).arg( ( long )auxerror ); + return tr( "The password is too short" ); + case PWQ_ERROR_ROTATED: + return tr( "The password is just rotated old one" ); + case PWQ_ERROR_MIN_CLASSES: + if ( auxerror ) + return tr( "The password contains less than %1 character classes" ).arg( ( long )auxerror ); + return tr( "The password does not contain enough character classes" ); + case PWQ_ERROR_MAX_CONSECUTIVE: + if ( auxerror ) + return tr( "The password contains more than %1 same characters consecutively" ).arg( ( long )auxerror ); + return tr( "The password contains too many same characters consecutively" ); + case PWQ_ERROR_MAX_CLASS_REPEAT: + if ( auxerror ) + return tr( "The password contains more than %1 characters of the same class consecutively" ).arg( ( long )auxerror ); + return tr( "The password contains too many characters of the same class consecutively" ); + case PWQ_ERROR_MAX_SEQUENCE: + if ( auxerror ) + return tr( "The password contains monotonic sequence longer than %1 characters" ).arg( ( long )auxerror ); + return tr( "The password contains too long of a monotonic character sequence" ); + case PWQ_ERROR_EMPTY_PASSWORD: + return tr( "No password supplied" ); + case PWQ_ERROR_RNG: + return tr( "Cannot obtain random numbers from the RNG device" ); + case PWQ_ERROR_GENERATION_FAILED: + return tr( "Password generation failed - required entropy too low for settings" ); + case PWQ_ERROR_CRACKLIB_CHECK: + if ( auxerror ) + { + /* Here the string comes from cracklib, don't free? */ + return tr( "The password fails the dictionary check - %1" ).arg( ( const char* )auxerror ); + } + return tr( "The password fails the dictionary check" ); + case PWQ_ERROR_UNKNOWN_SETTING: + if ( auxerror ) + { + QString s = tr( "Unknown setting - %1" ).arg( ( const char* )auxerror ); + free( auxerror ); + return s; + } + return tr( "Unknown setting" ); + case PWQ_ERROR_INTEGER: + if ( auxerror ) + { + QString s = tr( "Bad integer value of setting - %1" ).arg( ( const char* )auxerror ); + free( auxerror ); + return s; + } + return tr( "Bad integer value" ); + case PWQ_ERROR_NON_INT_SETTING: + if ( auxerror ) + { + QString s = tr( "Setting %1 is not of integer type" ).arg( ( const char* )auxerror ); + free( auxerror ); + return s; + } + return tr( "Setting is not of integer type" ); + case PWQ_ERROR_NON_STR_SETTING: + if ( auxerror ) + { + QString s = tr( "Setting %1 is not of string type" ).arg( ( const char* )auxerror ); + free( auxerror ); + return s; + } + return tr( "Setting is not of string type" ); + case PWQ_ERROR_CFGFILE_OPEN: + return tr( "Opening the configuration file failed" ); + case PWQ_ERROR_CFGFILE_MALFORMED: + return tr( "The configuration file is malformed" ); + case PWQ_ERROR_FATAL_FAILURE: + return tr( "Fatal failure" ); + default: + return tr( "Unknown error" ); + } + } +#undef tr +private: + pwquality_settings_t* m_settings; + int m_rv; + void* m_auxerror; +} ; + +DEFINE_CHECK_FUNC( libpwquality ) +{ + if ( !value.canConvert( QVariant::List ) ) + { + cDebug() << "WARNING: libpwquality settings is not a list"; + return; + } + + QVariantList l = value.toList(); + unsigned int requirement_count = 0; + auto settings = std::make_shared(); + for ( const auto& v : l ) + { + if ( v.type() == QVariant::String ) + { + QString option = v.toString(); + int r = settings->set( option ); + if ( r ) + cDebug() << " .. WARNING: unrecognized libpwquality setting" << option; + else + { + cDebug() << " .. libpwquality setting" << option; + ++requirement_count; + } + } + else + cDebug() << " .. WARNING: unrecognized libpwquality setting" << v; + } + + /* Something actually added? */ + if ( requirement_count ) + { + checks.push_back( + PasswordCheck( + [parent,settings]() + { + return settings->explanation( parent ); + }, + [settings]( const QString& s ) + { + int r = settings->check( s ); + if ( r < 0 ) + cDebug() << "WARNING: libpwquality error" << r; + else if ( r < settings->arbitrary_minimum_strength ) + cDebug() << "Password strength" << r << "too low"; + return r >= settings->arbitrary_minimum_strength; + } + ) ); + } +} +#endif diff --git a/src/modules/users/CheckPWQuality.h b/src/modules/users/CheckPWQuality.h new file mode 100644 index 000000000..b9ea82ce1 --- /dev/null +++ b/src/modules/users/CheckPWQuality.h @@ -0,0 +1,83 @@ +/* === This file is part of Calamares - === + * + * Copyright 2018, Adriaan de Groot + * + * Calamares is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Calamares is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Calamares. If not, see . + */ + +#ifndef CHECKPWQUALITY_H +#define CHECKPWQUALITY_H + +#include +#include +#include + +#include + +/** + * Support for (dynamic) checks on the password's validity. + * This can be used to implement password requirements like + * "at least 6 characters". Function addPasswordCheck() + * instantiates these and adds them to the list of checks. + */ +class PasswordCheck +{ +public: + /** Return true if the string is acceptable. */ + using AcceptFunc = std::function; + using MessageFunc = std::function; + + /** Generate a @p message if @p filter returns true */ + PasswordCheck( MessageFunc message, AcceptFunc filter ); + /** Yields @p message if @p filter returns true */ + PasswordCheck( const QString& message, AcceptFunc filter ); + /** Null check, always returns empty */ + PasswordCheck(); + + /** Applies this check to the given password string @p s + * and returns an empty string if the password is ok + * according to this filter. Returns a message describing + * what is wrong if not. + */ + QString filter( const QString& s ) const + { + return m_accept( s ) ? QString() : m_message(); + } + +private: + MessageFunc m_message; + AcceptFunc m_accept; +} ; + +using PasswordCheckList = QVector; + +/* Each of these functions adds a check (if possible) to the list + * of checks; they use the configuration value(s) from the + * variant. If the value doesn't make sense, each function + * may skip adding a check, and do nothing (it should log + * an error, though). + */ +#define _xDEFINE_CHECK_FUNC(x) \ + add_check_##x( QWidget* parent, PasswordCheckList& checks, const QVariant& value ) +#define DEFINE_CHECK_FUNC(x) void _xDEFINE_CHECK_FUNC(x) +#define DECLARE_CHECK_FUNC(x) void _xDEFINE_CHECK_FUNC(x); + +DECLARE_CHECK_FUNC(minLength) +DECLARE_CHECK_FUNC(maxLength) +#ifdef HAVE_LIBPWQUALITY +DECLARE_CHECK_FUNC(libpwquality) +#endif + +#endif + diff --git a/src/modules/users/UsersPage.cpp b/src/modules/users/UsersPage.cpp index 62f558a1e..8ea961662 100644 --- a/src/modules/users/UsersPage.cpp +++ b/src/modules/users/UsersPage.cpp @@ -455,68 +455,23 @@ UsersPage::setReusePasswordDefault( bool checked ) emit checkReady( isReady() ); } -UsersPage::PasswordCheck::PasswordCheck() - : m_message() - , m_accept( []( const QString& s ) -{ - return true; -} ) -{ -} - -UsersPage::PasswordCheck::PasswordCheck( const QString& m, AcceptFunc a ) - : m_message( [m](){ return m; } ) - , m_accept( a ) -{ -} - -UsersPage::PasswordCheck::PasswordCheck( MessageFunc m, AcceptFunc a ) - : m_message( m ) - , m_accept( a ) -{ -} - void UsersPage::addPasswordCheck( const QString& key, const QVariant& value ) { if ( key == "minLength" ) { - int minLength = -1; - if ( value.canConvert( QVariant::Int ) ) - minLength = value.toInt(); - if ( minLength > 0 ) - { - cDebug() << key << " .. set to" << minLength; - m_passwordChecks.push_back( - PasswordCheck( - []() - { - return tr( "Password is too short" ); - }, - [minLength]( const QString& s ) - { - return s.length() >= minLength; - } ) ); - } + add_check_minLength( this, m_passwordChecks, value ); } else if ( key == "maxLength" ) { - int maxLength = -1; - if ( value.canConvert( QVariant::Int ) ) - maxLength = value.toInt(); - if ( maxLength > 0 ) - { - cDebug() << key << " .. set to" << maxLength; - m_passwordChecks.push_back( - PasswordCheck( []() - { - return tr( "Password is too long" ); - }, [maxLength]( const QString& s ) - { - return s.length() <= maxLength; - } ) ); - } + add_check_maxLength( this, m_passwordChecks, value ); } +#ifdef CHECK_PWQUALITY + else if ( key == "libpwquality" ) + { + add_check_libpwquality( this, m_passwordChecks, value ); + } +#endif else - cDebug() << "WARNING: Unknown password-check key" << '"' << key << '"'; + cDebug() << "WARNING: Unknown password-check key" << key; } diff --git a/src/modules/users/UsersPage.h b/src/modules/users/UsersPage.h index 8bfcdb83b..5990d8693 100644 --- a/src/modules/users/UsersPage.h +++ b/src/modules/users/UsersPage.h @@ -26,9 +26,9 @@ #include "Typedefs.h" -#include +#include "CheckPWQuality.h" -#include +#include namespace Ui { @@ -70,41 +70,7 @@ signals: private: Ui::Page_UserSetup* ui; - /** - * Support for (dynamic) checks on the password's validity. - * This can be used to implement password requirements like - * "at least 6 characters". Function addPasswordCheck() - * instantiates these and adds them to the list of checks. - */ - class PasswordCheck - { - public: - /** Return true if the string is acceptable. */ - using AcceptFunc = std::function; - using MessageFunc = std::function; - - /** Generate a @p message if @p filter returns true */ - PasswordCheck( MessageFunc message, AcceptFunc filter ); - /** Yields @p message if @p filter returns true */ - PasswordCheck( const QString& message, AcceptFunc filter ); - /** Null check, always returns empty */ - PasswordCheck(); - - /** Applies this check to the given password string @p s - * and returns an empty string if the password is ok - * according to this filter. Returns a message describing - * what is wrong if not. - */ - QString filter( const QString& s ) const - { - return m_accept( s ) ? QString() : m_message(); - } - - private: - MessageFunc m_message; - AcceptFunc m_accept; - } ; - QVector m_passwordChecks; + PasswordCheckList m_passwordChecks; const QRegExp USERNAME_RX = QRegExp( "^[a-z_][a-z0-9_-]*[$]?$" ); const QRegExp HOSTNAME_RX = QRegExp( "^[a-zA-Z0-9][-a-zA-Z0-9_]*$" ); diff --git a/src/modules/users/users.conf b/src/modules/users/users.conf index 1f62fc1e5..6111a6e80 100644 --- a/src/modules/users/users.conf +++ b/src/modules/users/users.conf @@ -58,7 +58,19 @@ doReusePassword: true # (e.g. specifying a maximum length less than the minimum length # will annoy users). # -# (additional checks may be implemented in UsersPage.cpp) +# The libpwquality check relies on the (optional) libpwquality library. +# Its value is a list of configuration statements that could also +# be found in pwquality.conf, and these are handed off to the +# libpwquality parser for evaluation. The check is ignored if +# libpwquality is not available at build time (generates a warning in +# the log). The Calamares password check rejects passwords with a +# score of < 40 with the given libpwquality settings. +# +# (additional checks may be implemented in CheckPWQuality.cpp and +# wired into UsersPage.cpp) passwordRequirements: minLength: -1 # Password at least this many characters maxLength: -1 # Password at most this many characters + libpwquality: + - minlen=8 + - minclass=2