Giter Club home page Giter Club logo

chlorine-finder's Introduction

chlorine-finder

A Java Library to detect sensitive data.

Chlorine-finder is an open source library to detect sensitive elements in text. It is java based. Chlorine-finder can detect different types of Credit card numbers, SSN, Phone Numbers, email adddresses, Ip Addresses, Street Addresses and more.

###To Download source code

git clone https://github.com/dataApps/chlorine-finder.git

###To build chlorine-finder

mvn install

###To use Chlorine-finder

  • Add a dependency to Chlorine-finder library.

Maven dependency Definition

   <dependency>
      <groupId>io.dataapps.chlorine</groupId>
      <artifactId>chlorine-finder</artifactId>
      <version>1.1.5</version>
   </dependency>
  • Add the following lines of Code:
 FinderEngine engine = new FinderEngine();
 List<String> matchedValues = engine.find ("Here is my id : [email protected] and my machine inf o:  124.234.223.12 , ok ?");

The matchedValues will contain the email Address [email protected] and the ip-address 124.234.223.12. If there are multiple sensitive elements, then all of them will be returned.

Chlorine-finder internally uses a set of Finders to perform detection. The Finders can be specified as a regular expression or a Java Class.

Download library jar

The latest chlorine-finder library can be downloaded here.

###Further Documentation chlorine-finder wiki

###Related projects

  • Online Redactor - Masks sensitive elements from the input text. Users can customize the rules.
  • Chlorine-hadoop - detect and mask sensitive elements in Hadoop Clusters.
  • Chlorine-hive - detect and mask sensitive elements in Hive tables.

###Java Docs The java docs for chlorine-finder are available here.

We welcome all contributions. You can contribute features, enhancements, bug fixes or new Finders.

##Want to contribute features, bug fixes, enhancements?

Fork it
Create your feature branch (git checkout -b my-new-feature)
Take a look at the issues
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

chlorine-finder's People

Contributors

dataapps avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.