LmcUser

KO | EN

gitlite — search

#python #react #ai #golang #machine-learning #rust #deep-learning #macos #java #kubernetes #awesome-list #security #pytorch #openai

(★ 19)

A generic user registration and authentication module for Laminas. Supports Laminas\Db and Doctrine2. (Formerly ZfcUser)

LmcUser 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

LmcUser
=======
[![Latest Stable Version](http://poser.pugx.org/lm-commons/lmc-user/v)](https://packagist.org/packages/lm-commons/lmc-user) 
[![Total Downloads](http://poser.pugx.org/lm-commons/lmc-user/downloads)](https://packagist.org/packages/lm-commons/lmc-user) 
[![Build](https://github.com/visto9259/LmcUser/actions/workflows/build_test.yml/badge.svg)](https://github.com/visto9259/LmcUser/actions/workflows/build_test.yml)
![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flm-commons%2Flmcrbacmvc%2Fproperties%2Fvalues&query=%24%5B%3A1%5D.value&label=Maintenance%20Status)
[![Static Badge](https://img.shields.io/badge/Chat_on-Slack-blue)](https://join.slack.com/t/lm-commons/shared_invite/zt-2gankt2wj-FTS45hp1W~JEj1tWvDsUHQ)

Based on ZfcUser by Evan Coury and the ZF-Commons team

Introduction
------------

LmcUser is a user registration and authentication module for Laminas.
LmcUser provides the foundations for adding
user authentication and registration to your Laminas site. It is designed to be very
simple and easy to extend.

More information and examples are available on the [LmcUser Wiki](https://github.com/LM-Commons/LmcUser/wiki)

Requirements
------------

* [Laminas](https://github.com/laminas/) (latest master)

Features / Goals
----------------

* Authenticate via username, email, or both (can opt out of the concept of
  username and use strictly email) [COMPLETE]
* User registration [COMPLETE]
* Forms protected against CSRF [COMPLETE]
* Out-of-the-box support for Doctrine2 _and_ Laminas\Db [COMPLETE]
* Robust event system to allow for extending [COMPLETE]
* Provide ActionController plugin and view helper [COMPLETE]

Installation
------------

### Main Setup

#### With composer

1. Add this project in your composer.json:

```
    "require": {  
        "lm-commons/lmc-user": "^3.1"  
    }  
    ```

2. Now tell composer to download LmcUser by running the command:

```bash
    $ php composer.phar update
    ```

#### Post installation

1. Enabling it in your `application.config.php`file.

```php
    <?php
    return [
        'modules' => [
            // ...
            'LmcUser',
        ],
        // ...
    ];
    ```

### Post-Install: Laminas\Db

1. If you do not already have a valid Laminas\Db\Adapter\Adapter in your service
   manager configuration, put the following in `./config/autoload/database.local.php`:

```php
<?php
return [
    'db' => [
        'driver'    => 'PdoMysql',
        'hostname'  => 'changeme',
        'database'  => 'changeme',
        'username'  => 'changeme',
        'password'  => 'changeme',
    ],
    'service_manager' =>[
        'factories' => [
            \Laminas\Db\Adapter\Adapter::class => \Laminas\Db\Adapter\AdapterServiceFactory::class,
        ],
    ],
];

```

Navigate to http://yourproject/user and you should land on a login page.

Migration from ZfcUser
----------------------

If using Zend DB update table name to lmc_user

Replace all namespace references to ZfcUser to LmcUser

Update references to the lowercase key zfcuser to lmcuser

Password Security
-----------------

**DO NOT CHANGE THE PASSWORD HASH SETTINGS FROM THEIR DEFAULTS** unless A) you
have done sufficient research and fully understand exactly what you are
changing, **AND** B) you have a **very** specific reason to deviate from the
default settings.

If you are planning on changing the default password hash settings, please read
the following:

- [PHP Manual: crypt() function](http://php.net/manual/en/function.crypt.php)
- [Securely Storing Passwords in PHP by Adrian Schneider](http://www.syndicatetheory.com/labs/securely-storing-passwords-in-php)

The password hash settings may be changed at any time without invalidating existing
user accounts. Existing user passwords will be re-hashed automatically on their next
successful login.

**WARNING:** Changing the default password hash settings can cause serious
problems such as making your hashed passwords more vulnerable to brute force
attacks or making hashing so expensive that login and registration is
unacceptably slow for users and produces a large burden on your server(s). The
default settings provided are a very reasonable balance between the two,
suitable for computing power in 2013.

Options
-------

The  LmcUser module has some options to allow you to quickly customize the basic
functionality. After installing LmcUser, copy
`./vendor/lm-commons/lmc-user/config/lmcuser.global.php.dist` to
`./config/autoload/lmcuser.global.php` and change the values as desired.

The following options are available:

- **user_entity_class** - Name of Entity class to use. Useful for using your own
  entity class instead of the default one provided. Default is
  `LmcUser\Entity\User`.
- **enable_username** - Boolean value, enables username field on the
  registration form. Default is `false`.
- **auth_identity_fields** - Array value, specifies which fields a user can
  use as the 'identity' field when logging in.  Acceptable values: username, email.
Default is `false``.
- **enable_display_name** - Boolean value, enables a display name field on the
  registration form. Default value is `false`.
- **enable_registration** - Boolean value, Determines if a user should be
  allowed to register. Default value is `true`.
- **login_after_registration** - Boolean value, automatically logs the user in
  after they successfully register. Default value is `true`.
- **use_registration_form_captcha** - Boolean value, determines if a captcha should
  be utilized on the user registration form. Default value is `false`. (Note,
  right now this only utilizes a weak Laminas\Text\Figlet CAPTCHA.)
- **login_form_timeout** - Integer value, specify the timeout for the CSRF security
  field of the login form in seconds. Default value is 300 seconds.
- **user_form_timeout** - Integer value, specify the timeout for the CSRF security
  field of the registration form in seconds. Default value is 300 seconds.
- **use_redirect_parameter_if_present** - Boolean value, if a redirect GET
  parameter is specified, the user will be redirected to the specified URL if
  authentication is successful (if present, a GET parameter will override the
  login_redirect_route specified below). Default is `true`.
- **login_redirect_route** String value, name of a route in the application
  which the user will be redirected to after a successful login. Default is `lmcuser`.
- **logout_redirect_route** String value, name of a route in the application which
  the user will be redirected to after logging out. Default is `lmcuser/login`.
- **password_cost** - This should be an integer between 4 and 31. The number
  represents the base-2 logarithm of the iteration count used for hashing.
  Default is `14`.
- **enable_user_state** - Boolean value, enable user state usage. Should user's
  state be used in the registration/login process? Default is `false`.
- **default_user_state** - Integer value, default user state upon registration.
  What state user should have upon registration? Default is `1`.
- **allowed_login_states** - Array value, states which are allowing user to login.
  When user tries to login, is his/her state one of the following? Include null if
  you want user's with no state to login as well. Default values are `null` and `1`.

Changing Registration Captcha Element
-------------------------------------

**NOTICE** These instructions are currently out of date.

By default, the user registration uses the Figlet captcha engine.  This is
because it's the only one that doesn't require API keys.  It's possible to change
out the captcha engine with DI.  For example, to change to Recaptcha, you would
add this to one of your configuration files (global.config.php,
module.config.php, or a dedicated recaptcha.config.php):

<?php
    // ./config/autoload/recaptcha.config.php
    return  [
        'di'=>  [
            'instance'=> [
                'alias'=> [
                    // OTHER ELEMENTS....
                    'recaptcha_element' => \Laminas\Form\Element\Captcha::class,
                ],
                'recaptcha_element' =>  [
                    'parameters' => [
                        'spec' => 'captcha',
                        'options'=> [
                            'label'      => '',
                            'required'   => true,
                            'order'      => 500,
                            'captcha'    =>  [
                                'captcha' => 'ReCaptcha',
                                'privkey' => RECAPTCHA_PRIVATE_KEY,
                                'pubkey'  => RECAPTCHA_PUBLIC_KEY,
                            ],
                        ],
                    ],
                ],
                \LmcUser\Form\Register::class => [
                    'parameters' => [
                        'captcha_element'=>'recaptcha_element',
                    ],
                ],
            ],
        ],
    ];

LmcUser

LmcUser 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

LmcUser

LmcUser 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README