SSEPy: Implementation of searchable symmetric encryption in pure Python

Overview

SSEPy: Implementation of searchable symmetric encryption in pure Python

SSEPy Logo

Searchable symmetric encryption, one of the research hotspots in applied cryptography, has continued to be studied for two decades. A number of excellent SSE schemes have emerged, enriching functionality and optimizing performance. However, many SSE schemes have not been implemented concretely and are generally stuck in the prototype implementation stage, and worse, most SSE schemes are not publicly available in source code. Based on this foundation, this project first implements SSE schemes (first single-keyword, then multi-keyword) published in top conferences and journals, and then implements them into concrete applications. I hope that this project will provide a good aid for researchers as well as a reference for industry.

This is a project that is moving forward...

Usage

Environment

  • Python 3.8
  • OpenSSL
  • libffi
  • build-essential (for Debain), build-base (for Alpine)

Install Required Packages

Before running, you need to install the necessary packages

pip3 install -r requirements.txt

Adjust global configuration

The global configuration file is on global_config.py, which is divided into client-side global configuration and server-side global configuration. The example files are as follows:

import logging


# FOR CLIENT
class ClientConfig:
    SERVER_URI = "ws://localhost:8001"
    CONSOLE_LOG_LEVEL = logging.WARNING
    FILE_LOG_LEVEL = logging.INFO


# FOR SERVER
class ServerConfig:
    HOST = ""
    PORT = 8001

Among them, ClientConfig indicates the client configuration, where SERVER_URI indicates the WebSocket address of the server, CONSOLE_LOG_LEVEL indicates the console log output level, and FILE_LOG_LEVEL indicates the file log output level; ServerConfig indicates the server configuration, where HOST indicates the listening address, and PORT indicates the bound port.

Server

The server just needs to run run_server.py

Run Server

 python3 run_server.py start

Client

1. Generate Config File

The CLI command generate-config generates a default configuration file by giving the SSE scheme name and configuration file output path. The user can then open the configuration file and modify it as needed.

  • command: generate-config

  • options:

    • --scheme: the name of the SSE scheme
    • --save-path: the path where the configuration file is saved
  • example:

    python3 run_client.py generate-config --scheme CJJ14.PiBas --save-path cjj14_config
    
    >>> Create default config of CJJ14.PiBas successfully.
    

    The default configuration of the PiBas scheme is as follows:

    {
      "scheme": "CJJ14.PiBas", 
      "param_lambda": 32, 
      "prf_f_output_length": 32,
      "prf_f": "HmacPRF",
      "ske": "AES-CBC"
    }

2. According to the configuration, create an SSE service

Given a configuration file path, the client CLI command create-service creates a service and returns the service id (sid).

  • command: create-service
  • options:
    • --config: the file path of configuration
    • --sname: service name, an alias of service id
  • returns: the sid of the created service
  • example:
    python3 run_client.py create-service --config cjj14_config --sname pibas_s0
    
    >>> Create service e9cbf76d6578ba967f5a1d80250096f59a0524cea9c8a4d47f0bf92c157f1959 successfully.
    >>> sid: e9cbf76d6578ba967f5a1d80250096f59a0524cea9c8a4d47f0bf92c157f1959
    >>> sname: pibas_s0
    
    where e9cbf76d6578ba967f5a1d80250096f59a0524cea9c8a4d47f0bf92c157f1959 is the service id

3. Upload configuration file

After the configuration file is created, the user can use the upload-config command, enter the sid (service id) or sname (service name), and the CLI uploads the configuration file of the service to the server.

  • command: upload-config
  • options:
    • --sid or --sname: (choose one of two) the service id or service name
  • example:
    python3 run_client.py upload-config --sname pibas_s0
    
    >>> Upload config successfully
    

4. Create SSE Key

After the configuration file is created, the user can use the command generate-key, enter the sid or sname, and the CLI will generate the SSE key.

  • command: generate-key
  • options:
    • --sid or --sname: (choose one of two) the service id or service name
  • example:
    python3 run_client.py generate-key --sname pibas_s0
    
    >>> Generate key successfully.
    

5. Generate Encrypted Database

After creating the configuration file and key, the user can use the command encrypt-database, enter the sid (or sname) and database path, and the CLI will generate an encrypted database.

  • command: encrypt-database
  • options:
    • --sid or --sname: (choose one of two) the service id or service name
    • --db-path: the file path of database
  • example:
    python3 run_client.py encrypt-database --sname pibas_s0 --db-path example_db.json
    
    >>> Encrypted Database successfully.
    

Currently, the database is a json file. Our project provides an example database example_db.json, the content is as follows.

{
  "China": [
    "3A4B1ACC",
    "2DDD1FFF",
    "1122AA4B",
    "C2C2C2C2"
  ],
  "Github": [
    "1A1ADD2C",
    "2222CC1F"
  ],
  "Chen": [
    "1BB2BB2B",
    "23327878",
    "88771ABB"
  ]
}

The database consists of a dictionary where the keys are utf-8 strings and the values are an array whose elements are hex strings (don't start with 0x).

6. Upload Encrypted Database

After the database is created, the user can use the command upload-encrypted-database, enter the sid, and the CLI will upload the encrypted database to the server.

  • command: upload-encrypted-database
  • options:
    • --sid or --sname: (choose one of two) the service id or service name
  • example:
    python3 run_client.py upload-encrypted-database --sname pibas_s0
    
    >>> Upload encrypted database successfully
    

7. Keyword Search

After the encrypted database is uploaded, the user can use the search command, enter a keyword (currently only single-keyword search is supported) and the sid, encrypt it into a token and upload it to the server for searching.

  • command: search
  • options:
    • --sid or --sname: (choose one of two) the service id or service name
    • --keyword: the query keyword
  • example:
    python3 run_client.py search --keyword Chen --sname pibas_s0
    
    >>> The result is [b'\x1b\xb2\xbb+', b'#2xx', b'\x88w\x1a\xbb'].
    

Implemented schemes

Single-keyword Static SSE Schemes

  • (Completed) SSE-1 and SSE-2 in [CGKO06]: Curtmola, Reza, et al. "Searchable symmetric encryption: improved definitions and efficient constructions." Proceedings of the 13th ACM conference on Computer and communications security. 2006.
  • (Completed) Schemes PiBas, PiPack, PiPtr and Pi2Lev in [CJJ+14]: Cash, David, et al. "Dynamic Searchable Encryption in Very-Large Databases: Data Structures and Implementation." (2014).
  • (Completed) Scheme Pi in [CT14]: Cash, David, and Stefano Tessaro. "The locality of searchable symmetric encryption." Annual international conference on the theory and applications of cryptographic techniques. Springer, Berlin, Heidelberg, 2014.
  • (Completed) Scheme 3 (Section 5, Construction 5.1) in [ANSS16]: Asharov, Gilad, et al. "Searchable symmetric encryption: optimal locality in linear space via two-dimensional balanced allocations." Proceedings of the forty-eighth annual ACM symposium on Theory of Computing. 2016.
  • (Completed) Scheme in [DP17]: Demertzis, Ioannis, and Charalampos Papamanthou. "Fast searchable encryption with tunable locality." Proceedings of the 2017 ACM International Conference on Management of Data. 2017.
This is a webpage that contains login and signup page by which the password is stored using elliptic curve cryptography

LoginPage_using_Elliptic_curve_cryptography- This is a webpage that contains login and signup page by which the password is stored using elliptic curv

1 Oct 15, 2021
cairo_kernel is a simple Jupyter kernel for Cairo a smart contract programing language for STARKs.

cairo_kernel cairo_kernel is a simple Jupyter kernel for Cairo a smart contract programing language for STARKs. Installation Install virtualenv virtua

Ankit Chiplunkar 29 Sep 21, 2022
Tracking (of choice) cryptocurrencies' daily prices and moving average.

Crypto-price-moving_average Tracking (of choice) cryptocurrencies' daily prices and moving average. About Alpha Vantage The Alpha Vantage library (htt

Thong Huynh 2 Jan 22, 2022
G-Research-Crypto-Competition - Project for passing the ML exam. Dataset took from the competition on the kaggle

G-Research-Crypto-Competition Project for passing the ML exam. Dataset took from

5 Jan 09, 2022
Scrambler - Useful File/Directory Encryption Program

This is a program that is used to scramble/encrypt files on your computer. Do not use this program to do malicious things with. I am not responsible for any damage that you do with this software.

0 Oct 01, 2021
😈 Shining is a tool that enables engineers to remotely pull smart contract code in multi-file situations.

πŸ‘‘ Shining 😈 Shining is a tool that enables engineers to remotely pull smart contract code in multi-file situations. Shining is the name of one of my

xxxeyJ 15 Jun 17, 2022
a BTC mining program based on python3

BTC-Miner a BTC mining program based on python3 Our project refers to the nightminer project by ricmoo, which is written in Python2 (https://github.co

6 Jul 31, 2022
Aza this is a text encryption software

Aza text encryptor General info Aza this is a text encryption software Help command: python aza.py --help Examples python aza.py --text "Sample text h

ToxidWorm 1 Sep 10, 2022
Run with one command grafana, prometheus, and a python script to collect and display cryptocurrency prices and track your wallet balance.

CryptoWatch Track your favorite crypto coin price and your wallet balance. Install Create .env: ADMIN_USER=admin ADMIN_PASSWORD=admin Configure you

Rafael Zimmermann 13 Dec 13, 2022
Skepticoin is a peer-to-peer digital currency that enables you to send money online

What is Skepticoin? Skepticoin is a peer-to-peer digital currency that enables you to send money online. It's also the central community of people who

64 Aug 06, 2022
An advanced caesar cypher python module

CaesarPlus An advanced caesar cypher python module What is CaesarPlus CaesarPlus is a advanced caesar cypher python module that is more secure than ca

1 Mar 18, 2022
Highly decentralized and censorship-resistant way to store key data

Beacon coin Beacon coin is a Chia singelton coin that can store data that needs to be: always available censorship resistant versioned potentially imm

Sebastjan Trepca 24 Oct 04, 2022
This program generate hashes from random salts

Hash Generator This program generate hashes from random salts. How to install Install this program using python 3 and pip: pip install . In the future

Diesan Romero 2 Aug 20, 2022
Create and finder all address wallet bitcoin and check balance , transaction

BTCCrackWallet Create and finder all address wallet bitcoin and check balance , transaction bitcoin wallet generator generated address wallet , public

MMDRZA 11 Nov 26, 2022
Simple one-time pad (OTP) encryption

Introduction What you will make In this resource you will learn how to create and use an encryption technique known as the one-time pad. This method o

Rabih ND 6 Nov 06, 2022
A Python Tool to encrypt all types of files using AES and XOR Algorithm.

DataShield This project intends to protect user’s data, it stores files in encrypted format in device provided the passcode and path of the file. AES

ADITYA SHINDE 4 Dec 20, 2021
An encryption format offering better security, performance and ease of use than PGP.

An encryption format offering better security, performance and ease of use than PGP. File a bug if you found anything where we are worse than our competition, and we will fix it.

27 Dec 25, 2022
Fully configurable automated python script to collect most visted pages based on google dork

Ranked pages collector Fully configurable automated python script to collect most visted pages based on google dork Usage This project is still under

Security Analyzer 9 Sep 10, 2022
GreenDoge is a modern community-centric green cryptocurrency based on a proof-of-space-and-time consensus algorithm.

GreenDoge Blockchain Download GreenDoge blockchain GreenDoge is a modern community-centric green cryptocurrency based on a proof-of-space-and-time con

40 Sep 11, 2022
Smart-contracts - open sourcing our upcoming smart contracts for better security and transparency

Smart-contracts - open sourcing our upcoming smart contracts for better security and transparency

Rand Gallery 16 Jul 10, 2022