Alpha Framework 4.0.0 API Documentation

SecurityUtils
in package

A utility class for carrying out various security tasks.

Tags
since
1.2.2
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2021, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "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 COPYRIGHT HOLDER OR
CONTRIBUTORS 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.

Table of Contents

Properties

$cipher  : string
The HTTP user-agent client string.

Methods

checkAdminPasswordIsDefault()  : bool
Checks to see if the admin password provided matches the default admin password in the config file.
decrypt()  : string
Decrypt provided data using AES 256 algorithm and the security.encryption.key.
encrypt()  : string
Encrypt provided data using AES 256 algorithm and the security.encryption.key.

Properties

$cipher

The HTTP user-agent client string.

public static string $cipher = "aes-256-ecb"
Tags
since
3.1.0

Methods

checkAdminPasswordIsDefault()

Checks to see if the admin password provided matches the default admin password in the config file.

public static checkAdminPasswordIsDefault(string $password) : bool
Parameters
$password : string

The encrypted admin password stored in the database.

Tags
since
2.0.2
Return values
bool

decrypt()

Decrypt provided data using AES 256 algorithm and the security.encryption.key.

public static decrypt(string $data[, string $key = '' ]) : string
Parameters
$data : string
$key : string = ''

Optional, if provided use this as the key rather than the security.encryption.key setting.

Tags
since
1.2.2
Return values
string

encrypt()

Encrypt provided data using AES 256 algorithm and the security.encryption.key.

public static encrypt(string $data[, string $key = '' ]) : string
Parameters
$data : string
$key : string = ''

Optional, if provided use this as the key rather than the security.encryption.key setting.

Tags
since
1.2.2
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results