https://github.com/joomla-framework/crypt

Joomla Framework Crypt Package
https://github.com/joomla-framework/crypt

decryption encryption joomla joomla-framework php

Last synced: 15 days ago
JSON representation

Joomla Framework Crypt Package

• Host: GitHub
• URL: https://github.com/joomla-framework/crypt
• Owner: joomla-framework
• License: gpl-2.0
• Created: 2013-02-24T03:16:52.000Z (about 12 years ago)
• Default Branch: 3.x-dev
• Last Pushed: 2024-08-17T10:06:56.000Z (8 months ago)
• Last Synced: 2024-09-17T15:53:20.036Z (7 months ago)
• Topics: decryption, encryption, joomla, joomla-framework, php
• Language: PHP
• Homepage:
• Size: 5.29 MB
• Stars: 6
• Watchers: 14
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# The Crypt Package [![Build Status](https://ci.joomla.org/api/badges/joomla-framework/crypt/status.svg?ref=refs/heads/3.x-dev)](https://ci.joomla.org/joomla-framework/crypt)

[![Latest Stable Version](https://poser.pugx.org/joomla/crypt/v/stable)](https://packagist.org/packages/joomla/crypt)

[![Total Downloads](https://poser.pugx.org/joomla/crypt/downloads)](https://packagist.org/packages/joomla/crypt)

[![Latest Unstable Version](https://poser.pugx.org/joomla/crypt/v/unstable)](https://packagist.org/packages/joomla/crypt)

[![License](https://poser.pugx.org/joomla/crypt/license)](https://packagist.org/packages/joomla/crypt)

The Crypt password provides a set of classes that can be used for encrypting and hashing data.

## Interfaces

### `PasswordInterface`

`PasswordInterface` is an interface that requires a class to be implemented with a create and a verify method.

The create method should take a plain text password and a type and return a hashed password.

The verify method should accept a plain text password and a hashed password and return a boolean indicating whether or not the password matched the password in the hash.

The `PasswordInterface` interface defines the following constants for use with implementations:

- `PasswordInterface::BLOWFISH`

- `PasswordInterface::JOOMLA`

- `PasswordInterface::MD5`

- `PasswordInterface::PBKDF`

## Classes

### `Password\Simple`

#### Usage

In addition to the interface `PasswordInterface` there is also a basic implementation provided which provides for use with the most common password schemes. This if found in the `Password\Simple` class.

Aside from the two methods create and verify methods, this implementation also adds an additional method called setCost. This method is used to set a cost parameter for methods that support workload factors. It takes an integer cost factor as a parameter.

`Password\Simple` provides support for bcrypt, MD5 and the traditional Joomla! CMS hashing scheme. The hash format can be specified during hash creation by using the constants `PasswordInterface::BLOWFISH`, `PasswordInterface::MD5`, `PasswordInterface::JOOMLA`, and `PasswordInterface::PBKDF`. An appropriate salt will be automatically generated when required.

# Installation via Composer

Add `"joomla/crypt": "~3.0" to the require block in your composer.json and then run `composer install`.

```json

{

	"require": {

		"joomla/crypt": "~3.0"

	}

}

```

Alternatively, you can simply run the following from the command line:

```sh

composer require joomla/crypt "~3.0"

```

If you want to include the test sources, use

```sh

composer require --prefer-source joomla/crypt "~3.0"

```