pirk-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From eawilli...@apache.org
Subject incubator-pirk git commit: adding README.md file and contrib directory
Date Tue, 12 Jul 2016 21:11:50 GMT
Repository: incubator-pirk
Updated Branches:
  refs/heads/master ce05214bb -> 64eb7c036


adding README.md file and contrib directory


Project: http://git-wip-us.apache.org/repos/asf/incubator-pirk/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-pirk/commit/64eb7c03
Tree: http://git-wip-us.apache.org/repos/asf/incubator-pirk/tree/64eb7c03
Diff: http://git-wip-us.apache.org/repos/asf/incubator-pirk/diff/64eb7c03

Branch: refs/heads/master
Commit: 64eb7c036821d550641e22040b59cd6ec5e6ab31
Parents: ce05214
Author: eawilliams <eawilliams@apache.org>
Authored: Tue Jul 12 17:11:26 2016 -0400
Committer: eawilliams <eawilliams@apache.org>
Committed: Tue Jul 12 17:11:26 2016 -0400

----------------------------------------------------------------------
 README.md             |  87 +++++++++++++++++++++++++++++++++++++++++++++
 contrib/pirkImage.png | Bin 0 -> 54992 bytes
 2 files changed, 87 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/64eb7c03/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c772447
--- /dev/null
+++ b/README.md
@@ -0,0 +1,87 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+[![Apache Pirk](contrib/pirkImage.png)](http://pirk.incubator.apache.org)
+--
+
+Apache Pirk (incubating) is a framework for scalable Private Information Retrieval (PIR).
The goal of Pirk is to provide a landing place for robust, scalable, and practical implementations
of PIR algorithms.
+
+## Documentation
+
+Please see the [Apache Pirk](http://pirk.incubator.apache.org/) website for documentation.

+
+## Getting Started
+
+Pirk is written in Java and currently uses a Maven build system with a single level pom.xml.
As such, Pirk may be built via ‘mvn package’.
+
+For convenience, the following POM files are included:
+
+* pom.xml — Pirk pom file for Hadoop/YARN and Spark platforms
+* pom-with-benchmarks.xml — Pirk pom file for running Paillier benchmarking testing
+
+Pirk may be built with a specific pom file via ‘mvn package -f ’
+
+Dependencies can be found in the pom.xml file and include [Apache Hadoop](http://hadoop.apache.org/),
[Apache Spark](http://spark.apache.org/),  and [Elasticsearch](https://github.com/elastic/elasticsearch).
Currently, Pirk may be utilized in a distributed Hadoop/MapReduce or Spark framework as well
as in standalone mode.
+
+If you are a User, please check out the [For Users](http://pirk.incubator.apache.org/for_users)
section of the Pirk website.
+
+If you are a Developer, please check out the [For Developers](http://pirk.incubator.apache.org/for_developers)
section of the Pirk website.
+
+## Pirk Basics 
+
+[Private Information Retrieval](https://en.wikipedia.org/wiki/Private_information_retrieval)
(PIR) enables a user/entity to privately and securely obtain information from a dataset, to
which they have been granted access, without revealing, to the dataset owner or to an observer,
any information regarding the questions asked or the results obtained. Employing homomorphic
encryption techniques, PIR enables datasets to remain resident in their native locations while
giving the ability to query the datasets with sensitive terms.
+
+There are two parties in a PIR transaction - the Querier, the party asking encrypted questions,
and the Responder, the party holding the target data and answering encrypted questions (performing
encrypted queries).  
+
+Pirk is centered around the [Querier](http://pirk.incubator.apache.org/for_users#querier)
and the [Responder](http://pirk.incubator.apache.org/for_users#responder).
+
+In Pirk, the Querier is responsible for the following:
+
+* Generating the encrypted query vectors (representing encrypted questions)
+* Generating the necessary decryption items for each query vector
+* Decrypting encrypted query results obtained from the Responder
+
+Once the Querier generates an encrypted query, it must be sent to the Responder. 
+
+In Pirk, the Responder is responsible for the following:
+
+* Performing encrypted queries over their target datasets (using encrypted query vectors)
+* Forming the encrypted query results 
+
+The encrypted query results must be sent from the Responder back to the Querier for decryption.
+
+Pirk employs generic [data and query schemas](http://pirk.incubator.apache.org/for_users#data-and-query-schemas),
specified via XML files, that are shared between the Querier and Responder to enable flexible
and varied data and query types.
+
+## License 
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+   
+    (http://www.apache.org/licenses/LICENSE-2.0)
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License. See accompanying LICENSE file.
+
+
+## Apache Software Foundation Incubation
+
+Apache Pirk is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored
by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until
a further review indicates that the infrastructure, communications, and decision making process
have stabilized in a manner consistent with other successful ASF projects. While incubation
status is not necessarily a reflection of the completeness or stability of the code, it does
indicate that the project has yet to be fully endorsed by the ASF.
+

http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/64eb7c03/contrib/pirkImage.png
----------------------------------------------------------------------
diff --git a/contrib/pirkImage.png b/contrib/pirkImage.png
new file mode 100644
index 0000000..45805ea
Binary files /dev/null and b/contrib/pirkImage.png differ


Mime
View raw message