Chlorine Finder Library

Chlorine-finder is an open source library to detect sensitive elements in text

License

License

Categories

Categories

Data
GroupId

GroupId

io.dataapps.chlorine
ArtifactId

ArtifactId

chlorine-finder
Last Version

Last Version

1.1.5
Release Date

Release Date

Type

Type

jar
Description

Description

Chlorine Finder Library
Chlorine-finder is an open source library to detect sensitive elements in text
Project URL

Project URL

https://github.com/dataApps/chlorine-finder
Source Code Management

Source Code Management

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

Download chlorine-finder

How to add to project

<!-- https://jarcasting.com/artifacts/io.dataapps.chlorine/chlorine-finder/ -->
<dependency>
    <groupId>io.dataapps.chlorine</groupId>
    <artifactId>chlorine-finder</artifactId>
    <version>1.1.5</version>
</dependency>
// https://jarcasting.com/artifacts/io.dataapps.chlorine/chlorine-finder/
implementation 'io.dataapps.chlorine:chlorine-finder:1.1.5'
// https://jarcasting.com/artifacts/io.dataapps.chlorine/chlorine-finder/
implementation ("io.dataapps.chlorine:chlorine-finder:1.1.5")
'io.dataapps.chlorine:chlorine-finder:jar:1.1.5'
<dependency org="io.dataapps.chlorine" name="chlorine-finder" rev="1.1.5">
  <artifact name="chlorine-finder" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.dataapps.chlorine', module='chlorine-finder', version='1.1.5')
)
libraryDependencies += "io.dataapps.chlorine" % "chlorine-finder" % "1.1.5"
[io.dataapps.chlorine/chlorine-finder "1.1.5"]

Dependencies

compile (1)

Group / Artifact Type Version
commons-logging : commons-logging jar 1.2

test (1)

Group / Artifact Type Version
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

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

Versions

Version
1.1.5