Skip to content

Commit

Permalink
Merge pull request #41 from VirgilSecurity/develop
Browse files Browse the repository at this point in the history
Release v3.2.0
  • Loading branch information
SergeySeroshtan authored Apr 28, 2024
2 parents f049809 + 93ebaa8 commit 3982edc
Show file tree
Hide file tree
Showing 15 changed files with 1,317 additions and 954 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Build and Test
on:
push:
branches:
- "**"
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-13, windows-latest]
php-version: ["8.2", "8.3"]
include:
- os: ubuntu-latest
phpts: "nts"
- os: macos-13
phpts: "nts"
- os: windows-latest
phpts: "ts"
steps:
- uses: actions/checkout@v4
- name: Install PHP ${{ matrix.php-version }}
id: setup-php
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php-version }}
tools: composer:v2
env:
update: true
phpts: ${{ matrix.phpts }}
- name: Check PHP Version
run: php -v
- name: Build and Install
run: composer install
- name: Run Tests
if: runner.os != 'Windows'
shell: bash
env:
VIRGIL_PURE_KIT_ENV: ${{ secrets.VIRGIL_PURE_KIT_ENV }}
run: |
echo "${VIRGIL_PURE_KIT_ENV}" > .env
vendor/bin/phpunit --configuration phpunit.xml
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ vendor
composer_dev.json
composer_dev.lock
_dev/
.phpunit.result.cache
.phpunit.result.cache
.phpunit.cache
25 changes: 0 additions & 25 deletions .travis.yml

This file was deleted.

13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Virgil PureKit PHP
[![Build Status](https://travis-ci.com/VirgilSecurity/virgil-purekit-php.png?branch=master)](https://travis-ci.com/VirgilSecurity/virgil-purekit-php)

[![Build Status](https://github.com/VirgilSecurity/virgil-purekit-php/actions/workflows/build.yml/badge.svg?branch=master)](https://travis-ci.com/VirgilSecurity/virgil-purekit-php)
[![GitHub license](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](https://github.com/VirgilSecurity/virgil/blob/master/LICENSE)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/virgil/purekit.svg?style=flat-square)](https://packagist.org/packages/virgil/purekit)
[![Total Downloads](https://img.shields.io/packagist/dt/virgil/purekit.svg?style=flat-square)](https://packagist.org/packages/virgil/purekit)
[![API Reference](https://img.shields.io/badge/API%20reference-purekit--php-green)](https://virgilsecurity.github.io/virgil-purekit-php/)

[Introduction](#introduction) | [Benefits](#benefits) | [Features](#features) | [Installation](#installation) | [Resources](#resources) | [License](#license) | [Support](#support)
[Introduction](#introduction) | [Benefits](#benefits) | [Features](#features) | [Installation](#installation) | [Resources](#resources) | [License](#license) | [Support](#support)

## Introduction

Expand All @@ -20,19 +21,19 @@ The framework can be used within any database or login system that uses a passwo
Virgil PureKit is based on the [Password-Hardened Encryption (PHE) protocol](https://virgilsecurity.com/wp-content/uploads/2018/11/PHE-Whitepaper-2018.pdf) – a powerful and revolutionary cryptographic technology that provides stronger and more modern security, that protects users' data and reduces the security risks associated with weak passwords.

PureKit brings data security to a new level in three ways:
1. **Replaces password hashing** in a way making it impossible to run offline and online attacks. By interacting with PHE Service, a standalone cryptographic service in Virgil Cloud dedicated to implement PHE protocol, PureKit creates a unique user’s record that is associated with the user password. It is important to note that a user password is never transmitted to the PHE service in any form.

1. **Replaces password hashing** in a way making it impossible to run offline and online attacks. By interacting with PHE Service, a standalone cryptographic service in Virgil Cloud dedicated to implement PHE protocol, PureKit creates a unique user’s record that is associated with the user password. It is important to note that a user password is never transmitted to the PHE service in any form.
2. **Encrypts data with user’s personal encryption keys**. PureKit gives users a possibility to encrypt their data with personal encryption keys, and all keys can be revealed only after providing a correct password.
3. **Immediately invalidate stolen database**. Even if your database has been compromised it impossible to run offline attacks, to retrieve user password or decrypt data. At the same time, PureKit provides convenient and secure key rotation procedure, that allows you quickly update all your server keys without losing access to your data.

## Features

- Per-user data and files encryption
- Password protection against hacking
- Management of data encryption keys
- Management of data encryption keys
- Secure data and files sharing
- Role-based data encryption


## Benefits

- Users control data access
Expand Down Expand Up @@ -61,9 +62,11 @@ Navigate to our [Developer Documentation](https://developer.virgilsecurity.com/d
- [Virgil PHE WhitePaper](https://virgilsecurity.com/wp-content/uploads/2018/11/PHE-Whitepaper-2018.pdf) - foundation principles of the Password-Hardened Encryption (PHE) protocol.

## License

This library is released under the [3-clause BSD License](LICENSE).

## Support

Our developer support team is here to help you. Find out more information at our [Help Center](https://help.virgilsecurity.com/).

You can find us on [Twitter](https://twitter.com/VirgilSecurity) or send an email to our support team support@VirgilSecurity.com.
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.1.0
v3.2.0
18 changes: 12 additions & 6 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@
}
],
"require": {
"php": "^7.3|^8.0",
"vlucas/phpdotenv": "^2.5",
"guzzlehttp/guzzle": "~7.0",
"php": "^8.2",
"vlucas/phpdotenv": "^5.6",
"guzzlehttp/guzzle": "^7.8",
"google/protobuf": "^3.6.1",
"myclabs/php-enum": "^1.7",
"virgil/crypto": "*",
"myclabs/php-enum": "^1.8",
"virgil/crypto": "^6.3",
"ext-json": "*",
"ext-pdo": "*"
},
"require-dev": {
"phpunit/phpunit": "^8"
"phpunit/phpunit": "^11"
},
"autoload": {
"psr-4": {
Expand All @@ -40,5 +40,11 @@
"psr-4": {
"Virgil\\PureKitTests\\": "tests"
}
},
"scripts": {
"post-install-cmd": [
"chmod +x ./vendor/virgil/crypto-wrapper/_extensions/setup.sh",
"./vendor/virgil/crypto-wrapper/_extensions/setup.sh -all -vendor"
]
}
}
Loading

0 comments on commit 3982edc

Please sign in to comment.