http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/faq.html ---------------------------------------------------------------------- diff --git a/faq.html b/faq.html new file mode 100644 index 0000000..9138aaa --- /dev/null +++ b/faq.html @@ -0,0 +1,168 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<!-- + 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. +--> +<meta charset="utf-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link href="/pirk/css/bootstrap.min.css" rel="stylesheet"> +<link href="/pirk/css/bootstrap-theme.min.css" rel="stylesheet"> +<link href="/pirk/css/dataTables.bootstrap.css" rel="stylesheet"> +<link href="/pirk/css/pirk.css" rel="stylesheet" type="text/css"> +<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + +<title>FAQ</title> + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js";></script> +<script src="/pirk/js/bootstrap.min.js"></script> +<script src="/pirk/js/jquery.dataTables.min.js"></script> +<script src="/pirk/js/dataTables.bootstrap.js"></script> +<script> + // show location of canonical site if not currently on the canonical site + $(function() { + var host = window.location.host; + if (typeof host !== 'undefined' && host !== 'pirk.incubator.apache.org') { + $('#non-canonical').show(); + } + }); + + + // decorate menu with currently navigated page + $(function() { + $("#nav_faq").addClass("active"); + }); + + + $(function() { + // decorate section headers with anchors + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, icon, id; + $el = $(el); + id = $el.attr('id'); + icon = '<i class="fa fa-link"></i>'; + if (id) { + return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon)); + } + }); + }); + + // configure Google Analytics + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + if (ga.hasOwnProperty('loaded') && ga.loaded === true) { + ga('create', 'UA-50934829-1', 'apache.org'); + ga('send', 'pageview'); + } +</script> +</head> +<body style="padding-top: 100px"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/pirk/"><img id="nav-logo" alt="Apache Pirk" class="img-responsive" src="/pirk/images/pirkImage.png" width="150"/></a> + </div> + <div class="collapse navbar-collapse" id="navbar-items"> + <ul class="nav navbar-nav"> + <li class="nav-link"><a href="/pirk/downloads">Download</a></li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_users"><a href="/pirk/for_users">For Users</a></li> + <li id="nav_developers"><a href="/pirk/for_developers">For Developers</a></li> + <li id="nav_papers"><a href="/pirk/papers">Papers</a></li> + <li class="nav_faq"><a href="/pirk/faq">FAQ</a></li> + <li class="divider"></li> + <li><a href="/pirk/javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_getinvolvedpirk"><a href="/pirk/get_involved_pirk">Get Involved</a></li> + <li id="nav_listspirk"><a href="/pirk/mailing_list_pirk">Mailing Lists</a></li> + <li id="nav_peoplepirk"><a href="/pirk/people_pirk">People</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Development<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_releasing"><a href="/pirk/releasing">Making Releases</a></li> + <li id="nav_nav_verify_release"><a href="/pirk/verifying_releases">Verifying Releases</a></li> + <hr> + <li><a href="https://issues.apache.org/jira/browse/PIRK ">Issue Tracker/JIRA <i class="fa fa-external-link"></i></a></li> + <li><a href="https://builds.apache.org/view/A/view/Accumulo";>Jenkins Builds <i class="fa fa-external-link"></i></a></li> + <li><a href="https://github.com/apache/incubator-pirk";> Pirk Github Mirror <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + <li class="nav-link"><a href="/pirk/roadmap">Roadmap</a></li> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="https://www.apache.org";>Apache Homepage <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";>License <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/sponsorship";>Sponsorship <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/security";>Security <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/thanks";>Thanks <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + </ul> + </ul> + </div> + </div> +</nav> + + + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <div id="content"> + + <h1 class="title">FAQ</h1> + + <p>FAQ coming soon!</p> + + + </div> + + +<footer> + + <p><a href="https://www.apache.org";><img src="/pirk/images/feather-small.gif" alt="Apache Software Foundation" id="asf-logo" height="100" /></a></p> + + <p>Copyright © 2016-2016 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.</p> + +</footer> + + + </div> + </div> + </div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/faq.md ---------------------------------------------------------------------- diff --git a/faq.md b/faq.md deleted file mode 100644 index 40435eb..0000000 --- a/faq.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: FAQ -nav: nav_faq ---- - -FAQ coming soon! - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/feed.xml ---------------------------------------------------------------------- diff --git a/feed.xml b/feed.xml old mode 100755 new mode 100644 index a6628bd..91e6f00 --- a/feed.xml +++ b/feed.xml @@ -1,30 +1,14 @@ ---- -layout: null ---- <?xml version="1.0" encoding="UTF-8"?> <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom";> <channel> - <title>{{ site.title | xml_escape }}</title> - <description>{{ site.description | xml_escape }}</description> - <link>{{ site.url }}{{ site.baseurl }}/</link> - <atom:link href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" rel="self" type="application/rss+xml"/> - <pubDate>{{ site.time | date_to_rfc822 }}</pubDate> - <lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate> - <generator>Jekyll v{{ jekyll.version }}</generator> - {% for post in site.posts limit:10 %} - <item> - <title>{{ post.title | xml_escape }}</title> - <description>{{ post.content | xml_escape }}</description> - <pubDate>{{ post.date | date_to_rfc822 }}</pubDate> - <link>{{ post.url | prepend: site.baseurl | prepend: site.url }}</link> - <guid isPermaLink="true">{{ post.url | prepend: site.baseurl | prepend: site.url }}</guid> - {% for tag in post.tags %} - <category>{{ tag | xml_escape }}</category> - {% endfor %} - {% for cat in post.categories %} - <category>{{ cat | xml_escape }}</category> - {% endfor %} - </item> - {% endfor %} + <title>Apache Pirk (incubating)</title> + <description>Pirk is a framework for scalable Private Information Retrieval (PIR). +</description> + <link>http://pirk.incubator.apache.org//pirk/</link> + <atom:link href="http://pirk.incubator.apache.org//pirk/feed.xml"; rel="self" type="application/rss+xml"/> + <pubDate>Tue, 12 Jul 2016 09:25:34 -0400</pubDate> + <lastBuildDate>Tue, 12 Jul 2016 09:25:34 -0400</lastBuildDate> + <generator>Jekyll v3.1.6</generator> + </channel> </rss> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/for_developers.html ---------------------------------------------------------------------- diff --git a/for_developers.html b/for_developers.html new file mode 100644 index 0000000..cf04686 --- /dev/null +++ b/for_developers.html @@ -0,0 +1,307 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<!-- + 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. +--> +<meta charset="utf-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link href="/pirk/css/bootstrap.min.css" rel="stylesheet"> +<link href="/pirk/css/bootstrap-theme.min.css" rel="stylesheet"> +<link href="/pirk/css/dataTables.bootstrap.css" rel="stylesheet"> +<link href="/pirk/css/pirk.css" rel="stylesheet" type="text/css"> +<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + +<title>For Developers</title> + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js";></script> +<script src="/pirk/js/bootstrap.min.js"></script> +<script src="/pirk/js/jquery.dataTables.min.js"></script> +<script src="/pirk/js/dataTables.bootstrap.js"></script> +<script> + // show location of canonical site if not currently on the canonical site + $(function() { + var host = window.location.host; + if (typeof host !== 'undefined' && host !== 'pirk.incubator.apache.org') { + $('#non-canonical').show(); + } + }); + + + // decorate menu with currently navigated page + $(function() { + $("#nav_developers").addClass("active"); + }); + + + $(function() { + // decorate section headers with anchors + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, icon, id; + $el = $(el); + id = $el.attr('id'); + icon = '<i class="fa fa-link"></i>'; + if (id) { + return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon)); + } + }); + }); + + // configure Google Analytics + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + if (ga.hasOwnProperty('loaded') && ga.loaded === true) { + ga('create', 'UA-50934829-1', 'apache.org'); + ga('send', 'pageview'); + } +</script> +</head> +<body style="padding-top: 100px"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/pirk/"><img id="nav-logo" alt="Apache Pirk" class="img-responsive" src="/pirk/images/pirkImage.png" width="150"/></a> + </div> + <div class="collapse navbar-collapse" id="navbar-items"> + <ul class="nav navbar-nav"> + <li class="nav-link"><a href="/pirk/downloads">Download</a></li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_users"><a href="/pirk/for_users">For Users</a></li> + <li id="nav_developers"><a href="/pirk/for_developers">For Developers</a></li> + <li id="nav_papers"><a href="/pirk/papers">Papers</a></li> + <li class="nav_faq"><a href="/pirk/faq">FAQ</a></li> + <li class="divider"></li> + <li><a href="/pirk/javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_getinvolvedpirk"><a href="/pirk/get_involved_pirk">Get Involved</a></li> + <li id="nav_listspirk"><a href="/pirk/mailing_list_pirk">Mailing Lists</a></li> + <li id="nav_peoplepirk"><a href="/pirk/people_pirk">People</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Development<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_releasing"><a href="/pirk/releasing">Making Releases</a></li> + <li id="nav_nav_verify_release"><a href="/pirk/verifying_releases">Verifying Releases</a></li> + <hr> + <li><a href="https://issues.apache.org/jira/browse/PIRK ">Issue Tracker/JIRA <i class="fa fa-external-link"></i></a></li> + <li><a href="https://builds.apache.org/view/A/view/Accumulo";>Jenkins Builds <i class="fa fa-external-link"></i></a></li> + <li><a href="https://github.com/apache/incubator-pirk";> Pirk Github Mirror <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + <li class="nav-link"><a href="/pirk/roadmap">Roadmap</a></li> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="https://www.apache.org";>Apache Homepage <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";>License <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/sponsorship";>Sponsorship <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/security";>Security <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/thanks";>Thanks <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + </ul> + </ul> + </div> + </div> +</nav> + + + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <div id="content"> + + <h1 class="title">For Developers</h1> + + <ol> + <li><a href="#general-info">General Info</a></li> + <li><a href="#code-repo">Code Repo</a></li> + <li><a href="#coding-standards">Coding Standards</a> + <ul> + <li><a href="#apache-license-header">Apache License Header</a></li> + <li><a href="#author-tags">Author Tags</a></li> + <li><a href="#code-formatting">Code Formatting</a></li> + <li><a href="#ide-configuration-tips">IDE Configuration Tips</a> + <ul> + <li><a href="#eclipse">Eclipse</a></li> + <li><a href="#intellij">IntelliJ</a></li> + </ul> + </li> + </ul> + </li> + <li><a href="#javadocs">JavaDocs</a></li> + <li><a href="#building">Building</a></li> + <li><a href="#continuous-integration">Continuous Integration</a></li> + <li><a href="#testing">Testing</a></li> + <li><a href="#debugging">Debugging</a></li> + <li><a href="#paillier-benchmarking">Paillier Benchmarking</a></li> + <li><a href="#release-process">Release Process</a></li> +</ol> + +<h2 id="general-info">General Info</h2> + +<p>Pirk is written in Java 7 and build and dependency management is accomplished via <a href="https://maven.apache.org/";>Apache Maven</a>. Pirk uses <a href="https://git-scm.com/";>Git</a> for change management.</p> + +<h2 id="code-repo">Code Repo</h2> + +<p>The Pirk code is available via the <a href="https://git-wip-us.apache.org/repos/asf?p=incubator-pirk.git";>Pirk git repository</a> and is mirrored to <a href="https://github.com/apache/incubator-pirk";>Github</a>.</p> + +<p>To check out the code:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>git clone http://git.apache.org/incubator-pirk.git/ +</code></pre> +</div> + +<p>Then checkout the âmasterâ branch (which should be the default):</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>git checkout master +</code></pre> +</div> + +<h2 id="coding-standards">Coding Standards</h2> + +<h3 id="apache-license-header">Apache License Header</h3> + +<p>Always add the current ASF license header as described <a href="https://www.apache.org/legal/src-headers";>here</a>. Please use the provided âeclipse-pirk-template.xmlâ code template file to automatically add the ASF header to new code.</p> + +<h3 id="author-tags">Author Tags</h3> + +<p>Please do not use author tags; the code is developed and owned by the community.</p> + +<h3 id="code-formatting">Code Formatting</h3> + +<p>Pirk follows coding style practices found in the <a href="https://github.com/apache/incubator-pirk";>eclipse-pirk-codestyle.xml</a> file; please ensure that all contributions are formatted accordingly.</p> + +<h3 id="ide-configuration-tips">IDE Configuration Tips</h3> + +<h4 id="eclipse">Eclipse</h4> +<ul> + <li>Import Formatter: Properties > Java Code Style > Formatter and import the <a href="https://github.com/apache/incubator-pirk";>eclipse-pirk-codestyle.xml</a> file.</li> + <li>Import Template: Properties > Java Code Style > Code Templates and import the <a href="https://github.com/apache/incubator-pirk";>eclipse-pirk-codestyle.xml</a>. Make sure to check the âAutomatically add commentsâ box. This template adds the ASF header and so on for new code.</li> +</ul> + +<h4 id="intellij">IntelliJ</h4> +<ul> + <li>Formatter <a href="https://code.google.com/p/eclipse-code-formatter-intellij-plugin";>plugin</a> that uses eclipse code style xml.</li> +</ul> + +<h2 id="javadocs">JavaDocs</h2> + +<p>Pirk Javadocs may be found <a href="/pirk/javadocs">here</a>.</p> + +<h2 id="building">Building</h2> + +<p>Pirk currently follows a simple Maven build with a single level pom.xml. As such, Pirk may be built via âmvn packageâ.</p> + +<p>For convenience, the following POM files are included:</p> + +<ul> + <li>pom.xml â Pirk pom file for Hadoop/YARN and Spark platforms</li> + <li>pom-with-benchmarks.xml â Pirk pom file for running Paillier benchmarking testing</li> +</ul> + +<p>Pirk may be built with a specific pom file via âmvn package -f <specificPom.xml>â</specificPom.xml></p> + +<h2 id="continuous-integration">Continuous Integration</h2> + +<p>Pirk uses <a href="https://builds.apache.org/";>Jenkins</a> for continuous integration. The build history is available [here].</p> + +<h2 id="testing">Testing</h2> + +<p>JUnit in-memory unit and functional testing is performed by building with âmvn packageâ or running the tests with âmvn testâ. Specific tests may be run using the Maven command âmvn -Dtest=<testName> testâ.</testName></p> + +<p>Distributed functional testing may be performed on a cluster with the desired distributed computing technology installed. Currently, distributed implementations include batch processing in Hadoop MapReduce and Spark with inputs from HDFS or Elasticsearch.</p> + +<p>To run all of the distributed functional tests on a cluster, the following âhadoop jarâ command may be used:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>hadoop jar <pirkJar> org.apache.pirk.test.distributed.DistributedTestDriver -j <full path to pirkJar> +</code></pre> +</div> + +<p>Specific distributed test suites may be run via providing corresponding command line options. The available options are given by the following command:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>hadoop jar <pirkJar> org.apache.pirk.test.distributed.DistributedTestDriver âhelp +</code></pre> +</div> + +<p>The Pirk functional tests using Spark run via utilizing the <a href="https://spark.apache.org/docs/1.6.0/api/java/org/apache/spark/launcher/package-summary.html";>SparkLauncher</a> via the âhadoop jarâ command (not by directly running with âspark-submitâ). +To run successfully, the âspark.homeâ property must be set correctly in the âpirk.propertiesâ file; âspark-homeâ is the directory containing âbin/spark-submitâ.</p> + +<h2 id="debugging">Debugging</h2> + +<p>Pirk uses <a href="http://logging.apache.org/log4j/1.2/";>log4j</a> for logging. The log4j.properties file may be edited to turn allow a âdebugâ log level.</p> + +<h2 id="paillier-benchmarking">Paillier Benchmarking</h2> + +<p>Pirk includes a benchmarking package leveraging <a href="http://openjdk.java.net/projects/code-tools/jmh/";>JMH</a>. Currently, <a href="/pirk/javadocs/org/apache/pirk/benchmark/PaillierBenchmark">Paillier benchmarking</a> is enabled in Pirk.</p> + +<p>To build with benchmarks enabled, use:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>mvn package -f pom-with-benchmarks.xml +</code></pre> +</div> + +<p>To run the benchmarks, use:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>java -jar target/benchmarks.jar +</code></pre> +</div> + +<p>Optionally, you can reduce the number of times each benchmark is run (default is 10) using the -f flag. For example, to run each benchmark only twice, use: âjava -jar target/benchmarks.jar -f 2â</p> + +<p>FYI - Right now this spits out a lot of logging errors as the logger fails to work while benchmarks are running. Ignore the many stack traces and wait for execution to complete to see statistics on the different benchmarks.</p> + +<h2 id="release-process">Release Process</h2> + +<p>Please see <a href="/pirk/making_releases">Making Releases</a> and <a href="/pirk/verifying_releases">Verifying Releases</a>.</p> + + </div> + + +<footer> + + <p><a href="https://www.apache.org";><img src="/pirk/images/feather-small.gif" alt="Apache Software Foundation" id="asf-logo" height="100" /></a></p> + + <p>Copyright © 2016-2016 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.</p> + +</footer> + + + </div> + </div> + </div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/for_developers.md ---------------------------------------------------------------------- diff --git a/for_developers.md b/for_developers.md deleted file mode 100644 index d6fc438..0000000 --- a/for_developers.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: For Developers -nav: nav_developers ---- - -1. [General Info](#general-info) -2. [Code Repo](#code-repo) -3. [Coding Standards](#coding-standards) - * [Apache License Header](#apache-license-header) - * [Author Tags](#author-tags) - * [Code Formatting](#code-formatting) - * [IDE Configuration Tips](#ide-configuration-tips) - * [Eclipse](#eclipse) - * [IntelliJ](#intellij) -4. [JavaDocs](#javadocs) -5. [Building](#building) -6. [Continuous Integration](#continuous-integration) -7. [Testing](#testing) -8. [Debugging](#debugging) -9. [Paillier Benchmarking](#paillier-benchmarking) -10. [Release Process](#release-process) - - -## General Info - -Pirk is written in Java 7 and build and dependency management is accomplished via [Apache Maven](https://maven.apache.org/). Pirk uses [Git](https://git-scm.com/) for change management. - -## Code Repo - -The Pirk code is available via the [Pirk git repository](https://git-wip-us.apache.org/repos/asf?p=incubator-pirk.git) and is mirrored to [Github](https://github.com/apache/incubator-pirk). - -To check out the code: - - git clone http://git.apache.org/incubator-pirk.git/ - -Then checkout the 'master' branch (which should be the default): - - git checkout master - -## Coding Standards - -### Apache License Header - -Always add the current ASF license header as described [here](https://www.apache.org/legal/src-headers). Please use the provided âeclipse-pirk-template.xmlâ code template file to automatically add the ASF header to new code. - -### Author Tags - -Please do not use author tags; the code is developed and owned by the community. - -### Code Formatting - -Pirk follows coding style practices found in the [eclipse-pirk-codestyle.xml](https://github.com/apache/incubator-pirk) file; please ensure that all contributions are formatted accordingly. - -### IDE Configuration Tips - -#### Eclipse -* Import Formatter: Properties > Java Code Style > Formatter and import the [eclipse-pirk-codestyle.xml](https://github.com/apache/incubator-pirk) file. -* Import Template: Properties > Java Code Style > Code Templates and import the [eclipse-pirk-codestyle.xml](https://github.com/apache/incubator-pirk). Make sure to check the âAutomatically add commentsâ box. This template adds the ASF header and so on for new code. - -#### IntelliJ -* Formatter [plugin](https://code.google.com/p/eclipse-code-formatter-intellij-plugin) that uses eclipse code style xml. - -## JavaDocs - -Pirk Javadocs may be found [here]({{ site.baseurl }}/javadocs). - -## Building - -Pirk currently follows a simple Maven build 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 <specificPom.xml>â - -## Continuous Integration - -Pirk uses [Jenkins](https://builds.apache.org/) for continuous integration. The build history is available [here]. - -## Testing - -JUnit in-memory unit and functional testing is performed by building with âmvn packageâ or running the tests with âmvn testâ. Specific tests may be run using the Maven command âmvn -Dtest=<testName> testâ. - -Distributed functional testing may be performed on a cluster with the desired distributed computing technology installed. Currently, distributed implementations include batch processing in Hadoop MapReduce and Spark with inputs from HDFS or Elasticsearch. - -To run all of the distributed functional tests on a cluster, the following âhadoop jarâ command may be used: - - hadoop jar <pirkJar> org.apache.pirk.test.distributed.DistributedTestDriver -j <full path to pirkJar> - -Specific distributed test suites may be run via providing corresponding command line options. The available options are given by the following command: - - hadoop jar <pirkJar> org.apache.pirk.test.distributed.DistributedTestDriver âhelp - -The Pirk functional tests using Spark run via utilizing the [SparkLauncher](https://spark.apache.org/docs/1.6.0/api/java/org/apache/spark/launcher/package-summary.html) via the âhadoop jarâ command (not by directly running with âspark-submitâ). -To run successfully, the âspark.homeâ property must be set correctly in the âpirk.propertiesâ file; âspark-homeâ is the directory containing âbin/spark-submitâ. - -## Debugging - -Pirk uses [log4j](http://logging.apache.org/log4j/1.2/) for logging. The log4j.properties file may be edited to turn allow a âdebugâ log level. - -## Paillier Benchmarking - -Pirk includes a benchmarking package leveraging [JMH](http://openjdk.java.net/projects/code-tools/jmh/). Currently, [Paillier benchmarking]({{ site.baseurl }}/javadocs/org/apache/pirk/benchmark/PaillierBenchmark) is enabled in Pirk. - -To build with benchmarks enabled, use: - - mvn package -f pom-with-benchmarks.xml - -To run the benchmarks, use: - - java -jar target/benchmarks.jar - -Optionally, you can reduce the number of times each benchmark is run (default is 10) using the -f flag. For example, to run each benchmark only twice, use: âjava -jar target/benchmarks.jar -f 2â - -FYI - Right now this spits out a lot of logging errors as the logger fails to work while benchmarks are running. Ignore the many stack traces and wait for execution to complete to see statistics on the different benchmarks. - -## Release Process - -Please see [Making Releases]({{ site.baseurl }}/making_releases) and [Verifying Releases]({{ site.baseurl }}/verifying_releases). http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/for_users.html ---------------------------------------------------------------------- diff --git a/for_users.html b/for_users.html new file mode 100644 index 0000000..d0313bc --- /dev/null +++ b/for_users.html @@ -0,0 +1,313 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<!-- + 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. +--> +<meta charset="utf-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link href="/pirk/css/bootstrap.min.css" rel="stylesheet"> +<link href="/pirk/css/bootstrap-theme.min.css" rel="stylesheet"> +<link href="/pirk/css/dataTables.bootstrap.css" rel="stylesheet"> +<link href="/pirk/css/pirk.css" rel="stylesheet" type="text/css"> +<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + +<title>For Users</title> + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js";></script> +<script src="/pirk/js/bootstrap.min.js"></script> +<script src="/pirk/js/jquery.dataTables.min.js"></script> +<script src="/pirk/js/dataTables.bootstrap.js"></script> +<script> + // show location of canonical site if not currently on the canonical site + $(function() { + var host = window.location.host; + if (typeof host !== 'undefined' && host !== 'pirk.incubator.apache.org') { + $('#non-canonical').show(); + } + }); + + + // decorate menu with currently navigated page + $(function() { + $("#nav_users").addClass("active"); + }); + + + $(function() { + // decorate section headers with anchors + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, icon, id; + $el = $(el); + id = $el.attr('id'); + icon = '<i class="fa fa-link"></i>'; + if (id) { + return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon)); + } + }); + }); + + // configure Google Analytics + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + if (ga.hasOwnProperty('loaded') && ga.loaded === true) { + ga('create', 'UA-50934829-1', 'apache.org'); + ga('send', 'pageview'); + } +</script> +</head> +<body style="padding-top: 100px"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/pirk/"><img id="nav-logo" alt="Apache Pirk" class="img-responsive" src="/pirk/images/pirkImage.png" width="150"/></a> + </div> + <div class="collapse navbar-collapse" id="navbar-items"> + <ul class="nav navbar-nav"> + <li class="nav-link"><a href="/pirk/downloads">Download</a></li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_users"><a href="/pirk/for_users">For Users</a></li> + <li id="nav_developers"><a href="/pirk/for_developers">For Developers</a></li> + <li id="nav_papers"><a href="/pirk/papers">Papers</a></li> + <li class="nav_faq"><a href="/pirk/faq">FAQ</a></li> + <li class="divider"></li> + <li><a href="/pirk/javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_getinvolvedpirk"><a href="/pirk/get_involved_pirk">Get Involved</a></li> + <li id="nav_listspirk"><a href="/pirk/mailing_list_pirk">Mailing Lists</a></li> + <li id="nav_peoplepirk"><a href="/pirk/people_pirk">People</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Development<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_releasing"><a href="/pirk/releasing">Making Releases</a></li> + <li id="nav_nav_verify_release"><a href="/pirk/verifying_releases">Verifying Releases</a></li> + <hr> + <li><a href="https://issues.apache.org/jira/browse/PIRK ">Issue Tracker/JIRA <i class="fa fa-external-link"></i></a></li> + <li><a href="https://builds.apache.org/view/A/view/Accumulo";>Jenkins Builds <i class="fa fa-external-link"></i></a></li> + <li><a href="https://github.com/apache/incubator-pirk";> Pirk Github Mirror <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + <li class="nav-link"><a href="/pirk/roadmap">Roadmap</a></li> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="https://www.apache.org";>Apache Homepage <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";>License <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/sponsorship";>Sponsorship <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/security";>Security <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/thanks";>Thanks <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + </ul> + </ul> + </div> + </div> +</nav> + + + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <div id="content"> + + <h1 class="title">For Users</h1> + + <ol> + <li><a href="#system-requirements">System Requirements</a></li> + <li><a href="#target-data">Target Data</a></li> + <li><a href="#data-and-query-schemas">Data and Query Schemas</a> + <ul> + <li><a href="#data-schema">Data Schema</a></li> + <li><a href="#query-schema">Query Schema</a></li> + </ul> + </li> + <li><a href="#querier">Querier</a></li> + <li><a href="#responder">Responder</a> + <ul> + <li><a href="#platforms">Platforms</a></li> + <li><a href="#target-data">Target Data</a></li> + <li><a href="#launching">Launching</a></li> + <li><a href="#responder-output">Responder Output</a></li> + </ul> + </li> +</ol> + +<h2 id="system-requirements">System Requirements</h2> + +<p>Pirk requires JDK 1.7 (or greater). The remaining system requirements depend on the platform chosen for the Querier and Responder.</p> + +<h2 id="target-data">Target Data</h2> + +<p>Target data refers to the data to be queried. Target data can be read from HDFS, Elasticsearch, or from the local file system, or as input to the encrypted query functionality as a part of a larger workflow.</p> + +<p>Data over which the encrypted query is to be preformed must be transformed into a map of <key,value> pairs; JSON, MapWritable, and Map<String,Object> representations are currently used in Pirk to format target data. For a given data input represented as a set of <key,value> pairs, the âkeyâ corresponds to the name of the element or field of the data and the âvalueâ is the value of that field in the data.</p> + +<p>If the Responder is reading the target data from HDFS, an input format extending Pirkâs <a href="/pirk/javadocs/org/apache/pirk/inputformat/hadoop/BaseInputFormat">org.apache.pirk.inputformat.hadoop.BaseInputFormat</a> must be used; BaseInputFormat extends the <a href="https://hadoop.apache.org/docs/r2.7.2/api/org/apache/hadoop/mapred/InputFormat.html";>Hadoop InputFormat</a><<a href="https://hadoop.apache.org/docs/r2.6.2/api/org/apache/hadoop/io/Text.html";>Text</a>,<a href="https://hadoop.apache.org/docs/r2.6.2/api/org/apache/hadoop/io/MapWritable.html";>MapWritable</a>>.</p> + +<h2 id="data-and-query-schemas">Data and Query Schemas</h2> + +<p>In order to perform an encrypted query over a target data set, Pirk requires the user to specify a data schema XML file for the target data and a query schema XML file for the query type. Both the Querier and the Responder must have the data and query schema XML files.</p> + +<h3 id="data-schema">Data Schema</h3> + +<p>The format of the data schema XML file is as follows:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> <schema> + <schemaName> name of the data schema </schemaName> + <element> + <name> element name </name> + <type> class name or type name (if Java primitive type) of the element </type> + <isArray> true or false -- whether or not the schema element is an array within the data </isArray> + <partitioner> optional - Partitioner class for the element; defaults to primitive java type partitioner </partitioner> + </element> + </schema> + +Primitive Java types must be one of the following: "byte", "short", "int", "long", "float", "double", "char", "string", "boolean" +</code></pre> +</div> + +<p>Each element of the data is defined by its name, type, whether or not it is an array of objects of the given type, and an optional partitioner class.</p> + +<p>The element type may be one of the Java primitive types given above or may be defined by a custom class.</p> + +<p>The Partitioner class contains the functionality for partitioning the given data element into âchunksâ which are used in computing the encrypted query. If no partitioner is specified for an element, it defaults to the <a href="/pirk/javadocs/org/apache/pirk/schema/data/partitioner/PrimitiveTypePartitioner">org.apache.pirk.schema.data.partitioner.PrimitiveTypePartitioner</a> and assumes that the element type is one of the allowed primitive Java types (an exception will be thrown if this is not the case). All custom partitioners must implement the <a href="/pirk/javadocs/org/apache/pirk/schema/data/partitioner/DataPartitioner">org.apache.pirk.schema.data.partitioner.DataPartitioner</a> interface. There are several implemented Partitioners available in the <a href="/pirk/javadocs/org/apache/pirk/schema/data/partitioner">org.apache.pirk.schema.data.partitioner</a> package.</p> + +<h3 id="query-schema">Query Schema</h3> + +<p>The format of the query schema XML file is as follows:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><schema> + <schemaName> name of the query schema </schemaName> + <dataSchemaName> name of the data schema over which this query is run </dataSchemaName> + <selectorName> name of the element in the data schema that will be the selector </selectorName> + <elements> + <name> element name of element in the data schema to include in the query response </name> + </elements> + <filter> (optional) name of the filter class to use to filter the data </filter> + <filterNames> + <name> (optional) element name of element in the data schema to apply pre-processing filters </name> + </filterNames> +</schema> +</code></pre> +</div> + +<p>The selectorName is the name of the element in the corresponding data schema that is to be used as the primary selector or indicator for the query (see Wideskies paper [link]).</p> + +<p>The elements field specifies all elements (via <name>) within a given piece of data to return as part of the encrypted query.</p> + +<p>Optionally, the Responder can perform filtering on the input target data before performing the encrypted query. The filter class must implement the <a href="/pirk/javadocs/org/apache/pirk/schema/query/filter/DataFilter">org.apache.pirk.schema.query.filter.DataFilter</a> interface. Specific elements of a piece of input data on which the filter should be applied can be specified via <filterNames>; for example, for the <a href="/pirk/javadocs/org/apache/pirk/schema/query/filter/StopListFilter">org.apache.pirk.schema.query.filter.StopListFilter</a>, filterNames may include the qname if the target data is a set of DNS records.</p> + +<h2 id="querier">Querier</h2> + +<p>The Querier is currently written to operate in a standalone (non-distributed), multi-threaded mode.</p> + +<p>For Wideskies, the user will need to generate the encrypted query vector via the <a href="/pirk/javadocs/org/apache/pirk/querier/wideskies/QuerierDriver">QuerierDriver</a>. Options available for query generation are given by:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>java -cp <pirkJar> org.apache.pirk.querier.wideskies.QuerierDriver âhelp +</code></pre> +</div> + +<p>The QuerierDriver generates <a href="/pirk/javadocs/org/apache/pirk/query/wideskies/Query">Query</a> and <a href="/pirk/javadocs/org/apache/pirk/querier/wideskies/Querier">Querier</a> objects and serializes them, respectively, to two files.</p> + +<p>The Query object contains the encrypted query vectors and all information necessary for the Responder to perform the encrypted query. The file containing the Query object should be sent to the Responder platform; it is used as input for the Responder to execute the query.</p> + +<p>The Querier object contains the information necessary for the Querier to decrypt the results of the encrypted query. The file containing the Querier object must not be sent to the Responder as it contains the encryption/decryption keys for the query.</p> + +<h2 id="responder">Responder</h2> + +<h3 id="platforms">Platforms</h3> + +<p>The Responder currently operates on the following platforms:</p> + +<ul> + <li>Standalone, multithreaded (mainly used for testing purposes)</li> + <li>Spark batch, reading from HDFS or Elasticsearch</li> + <li>Hadoop MapReduce batch, reading from HDFS or Elasticsearch</li> +</ul> + +<p>The <a href="/pirk/roadmap">RoadMap</a> details plans for various streaming implementations.</p> + +<p>Components of the Responder implementations may also be called independently in custom workflows.</p> + +<h3 id="target-data-1">Target Data</h3> + +<p>Target data is assumed to be in HDFS for the distributed Responder variants and in the local file system for the standalone version.</p> + +<h3 id="launching">Launching</h3> + +<p>The Responder can be launched via the <a href="/pirk/javadocs/org/apache/pirk/responder/wideskies/ResponderDriver">ResponderDriver</a>. Options available via the ResponderDriver are given by:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>java -cp <pirkJar> org.apache.pirk.responder.wideskies.ResponderDriver âhelp +</code></pre> +</div> + +<p>When using the MapReduce implementation, launch the Responder via the following command:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>hadoop jar <pirkJar> org.apache.pirk.responder.wideskies.ResponderDriver <responder options> +</code></pre> +</div> + +<p>When using the Spark implementation, launch the Responder via spark-submit as follows:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>spark-submit <spark options> <pirkJar> org.apache.pirk.responder.wideskies.ResponderDriver <responder options> +</code></pre> +</div> + +<h3 id="responder-output">Responder Output</h3> + +<p>The Responder performs the encrypted query, stores the results in a <a href="/pirk/javadocs/org/apache/pirk/response/wideskies/Response">Response</a> object, and serializes this object to the output location specified in the <responder options>. For Responder implementations running in Hadoop MapReduce or Spark, this output file is stored in HDFS.</p> + +<p>The file containing the serialized Response object should be returned to the Querier for decryption.</p> + + + </div> + + +<footer> + + <p><a href="https://www.apache.org";><img src="/pirk/images/feather-small.gif" alt="Apache Software Foundation" id="asf-logo" height="100" /></a></p> + + <p>Copyright © 2016-2016 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.</p> + +</footer> + + + </div> + </div> + </div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/for_users.md ---------------------------------------------------------------------- diff --git a/for_users.md b/for_users.md deleted file mode 100644 index fa94e25..0000000 --- a/for_users.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: For Users -nav: nav_users ---- - -1. [System Requirements](#system-requirements) -2. [Target Data](#target-data) -3. [Data and Query Schemas](#data-and-query-schemas) - * [Data Schema](#data-schema) - * [Query Schema](#query-schema) -4. [Querier](#querier) -5. [Responder](#responder) - * [Platforms](#platforms) - * [Target Data](#target-data) - * [Launching](#launching) - * [Responder Output](#responder-output) - -## System Requirements - -Pirk requires JDK 1.7 (or greater). The remaining system requirements depend on the platform chosen for the Querier and Responder. - -## Target Data - -Target data refers to the data to be queried. Target data can be read from HDFS, Elasticsearch, or from the local file system, or as input to the encrypted query functionality as a part of a larger workflow. - -Data over which the encrypted query is to be preformed must be transformed into a map of <key,value> pairs; JSON, MapWritable, and Map\<String,Object\> representations are currently used in Pirk to format target data. For a given data input represented as a set of \<key,value\> pairs, the âkeyâ corresponds to the name of the element or field of the data and the âvalueâ is the value of that field in the data. - -If the Responder is reading the target data from HDFS, an input format extending Pirkâs [org.apache.pirk.inputformat.hadoop.BaseInputFormat]({{ site.baseurl }}/javadocs/org/apache/pirk/inputformat/hadoop/BaseInputFormat) must be used; BaseInputFormat extends the [Hadoop InputFormat](https://hadoop.apache.org/docs/r2.7.2/api/org/apache/hadoop/mapred/InputFormat.html)\<[Text](https://hadoop.apache.org/docs/r2.6.2/api/org/apache/hadoop/io/Text.html),[MapWritable](https://hadoop.apache.org/docs/r2.6.2/api/org/apache/hadoop/io/MapWritable.html)\>. - -## Data and Query Schemas - -In order to perform an encrypted query over a target data set, Pirk requires the user to specify a data schema XML file for the target data and a query schema XML file for the query type. Both the Querier and the Responder must have the data and query schema XML files. - -### Data Schema - -The format of the data schema XML file is as follows: - - - <schema> - <schemaName> name of the data schema </schemaName> - <element> - <name> element name </name> - <type> class name or type name (if Java primitive type) of the element </type> - <isArray> true or false -- whether or not the schema element is an array within the data </isArray> - <partitioner> optional - Partitioner class for the element; defaults to primitive java type partitioner </partitioner> - </element> - </schema> - - Primitive Java types must be one of the following: "byte", "short", "int", "long", "float", "double", "char", "string", "boolean" - - -Each element of the data is defined by its name, type, whether or not it is an array of objects of the given type, and an optional partitioner class. - -The element type may be one of the Java primitive types given above or may be defined by a custom class. - -The Partitioner class contains the functionality for partitioning the given data element into âchunksâ which are used in computing the encrypted query. If no partitioner is specified for an element, it defaults to the [org.apache.pirk.schema.data.partitioner.PrimitiveTypePartitioner]({{ site.baseurl }}/javadocs/org/apache/pirk/schema/data/partitioner/PrimitiveTypePartitioner) and assumes that the element type is one of the allowed primitive Java types (an exception will be thrown if this is not the case). All custom partitioners must implement the [org.apache.pirk.schema.data.partitioner.DataPartitioner]({{ site.baseurl }}/javadocs/org/apache/pirk/schema/data/partitioner/DataPartitioner) interface. There are several implemented Partitioners available in the [org.apache.pirk.schema.data.partitioner]({{ site.baseurl }}/javadocs/org/apache/pirk/schema/data/partitioner) package. - -### Query Schema - -The format of the query schema XML file is as follows: - - <schema> - <schemaName> name of the query schema </schemaName> - <dataSchemaName> name of the data schema over which this query is run </dataSchemaName> - <selectorName> name of the element in the data schema that will be the selector </selectorName> - <elements> - <name> element name of element in the data schema to include in the query response </name> - </elements> - <filter> (optional) name of the filter class to use to filter the data </filter> - <filterNames> - <name> (optional) element name of element in the data schema to apply pre-processing filters </name> - </filterNames> - </schema> - - -The selectorName is the name of the element in the corresponding data schema that is to be used as the primary selector or indicator for the query (see Wideskies paper [link]). - -The elements field specifies all elements (via \<name\>) within a given piece of data to return as part of the encrypted query. - -Optionally, the Responder can perform filtering on the input target data before performing the encrypted query. The filter class must implement the [org.apache.pirk.schema.query.filter.DataFilter]({{ site.baseurl }}/javadocs/org/apache/pirk/schema/query/filter/DataFilter) interface. Specific elements of a piece of input data on which the filter should be applied can be specified via \<filterNames\>; for example, for the [org.apache.pirk.schema.query.filter.StopListFilter]({{ site.baseurl }}/javadocs/org/apache/pirk/schema/query/filter/StopListFilter), filterNames may include the qname if the target data is a set of DNS records. - -## Querier - -The Querier is currently written to operate in a standalone (non-distributed), multi-threaded mode. - -For Wideskies, the user will need to generate the encrypted query vector via the [QuerierDriver]({{ site.baseurl }}/javadocs/org/apache/pirk/querier/wideskies/QuerierDriver). Options available for query generation are given by: - - java -cp <pirkJar> org.apache.pirk.querier.wideskies.QuerierDriver âhelp - -The QuerierDriver generates [Query]({{ site.baseurl }}/javadocs/org/apache/pirk/query/wideskies/Query) and [Querier]({{ site.baseurl }}/javadocs/org/apache/pirk/querier/wideskies/Querier) objects and serializes them, respectively, to two files. - -The Query object contains the encrypted query vectors and all information necessary for the Responder to perform the encrypted query. The file containing the Query object should be sent to the Responder platform; it is used as input for the Responder to execute the query. - -The Querier object contains the information necessary for the Querier to decrypt the results of the encrypted query. The file containing the Querier object must not be sent to the Responder as it contains the encryption/decryption keys for the query. - -## Responder - -### Platforms - -The Responder currently operates on the following platforms: - -* Standalone, multithreaded (mainly used for testing purposes) -* Spark batch, reading from HDFS or Elasticsearch -* Hadoop MapReduce batch, reading from HDFS or Elasticsearch - -The [RoadMap]({{ site.baseurl }}/roadmap) details plans for various streaming implementations. - -Components of the Responder implementations may also be called independently in custom workflows. - -### Target Data - -Target data is assumed to be in HDFS for the distributed Responder variants and in the local file system for the standalone version. - -### Launching - -The Responder can be launched via the [ResponderDriver]({{ site.baseurl }}/javadocs/org/apache/pirk/responder/wideskies/ResponderDriver). Options available via the ResponderDriver are given by: - - java -cp <pirkJar> org.apache.pirk.responder.wideskies.ResponderDriver âhelp - -When using the MapReduce implementation, launch the Responder via the following command: - - hadoop jar <pirkJar> org.apache.pirk.responder.wideskies.ResponderDriver <responder options> - -When using the Spark implementation, launch the Responder via spark-submit as follows: - - spark-submit <spark options> <pirkJar> org.apache.pirk.responder.wideskies.ResponderDriver <responder options> - -### Responder Output - -The Responder performs the encrypted query, stores the results in a [Response]({{ site.baseurl }}/javadocs/org/apache/pirk/response/wideskies/Response) object, and serializes this object to the output location specified in the \<responder options\>. For Responder implementations running in Hadoop MapReduce or Spark, this output file is stored in HDFS. - -The file containing the serialized Response object should be returned to the Querier for decryption. - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/get_involved_pirk.html ---------------------------------------------------------------------- diff --git a/get_involved_pirk.html b/get_involved_pirk.html new file mode 100644 index 0000000..fec2742 --- /dev/null +++ b/get_involved_pirk.html @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<!-- + 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. +--> +<meta charset="utf-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link href="/pirk/css/bootstrap.min.css" rel="stylesheet"> +<link href="/pirk/css/bootstrap-theme.min.css" rel="stylesheet"> +<link href="/pirk/css/dataTables.bootstrap.css" rel="stylesheet"> +<link href="/pirk/css/pirk.css" rel="stylesheet" type="text/css"> +<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + +<title>Get Involved</title> + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js";></script> +<script src="/pirk/js/bootstrap.min.js"></script> +<script src="/pirk/js/jquery.dataTables.min.js"></script> +<script src="/pirk/js/dataTables.bootstrap.js"></script> +<script> + // show location of canonical site if not currently on the canonical site + $(function() { + var host = window.location.host; + if (typeof host !== 'undefined' && host !== 'pirk.incubator.apache.org') { + $('#non-canonical').show(); + } + }); + + + // decorate menu with currently navigated page + $(function() { + $("#nav_getinvolvedpirk").addClass("active"); + }); + + + $(function() { + // decorate section headers with anchors + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, icon, id; + $el = $(el); + id = $el.attr('id'); + icon = '<i class="fa fa-link"></i>'; + if (id) { + return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon)); + } + }); + }); + + // configure Google Analytics + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + if (ga.hasOwnProperty('loaded') && ga.loaded === true) { + ga('create', 'UA-50934829-1', 'apache.org'); + ga('send', 'pageview'); + } +</script> +</head> +<body style="padding-top: 100px"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/pirk/"><img id="nav-logo" alt="Apache Pirk" class="img-responsive" src="/pirk/images/pirkImage.png" width="150"/></a> + </div> + <div class="collapse navbar-collapse" id="navbar-items"> + <ul class="nav navbar-nav"> + <li class="nav-link"><a href="/pirk/downloads">Download</a></li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_users"><a href="/pirk/for_users">For Users</a></li> + <li id="nav_developers"><a href="/pirk/for_developers">For Developers</a></li> + <li id="nav_papers"><a href="/pirk/papers">Papers</a></li> + <li class="nav_faq"><a href="/pirk/faq">FAQ</a></li> + <li class="divider"></li> + <li><a href="/pirk/javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_getinvolvedpirk"><a href="/pirk/get_involved_pirk">Get Involved</a></li> + <li id="nav_listspirk"><a href="/pirk/mailing_list_pirk">Mailing Lists</a></li> + <li id="nav_peoplepirk"><a href="/pirk/people_pirk">People</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Development<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_releasing"><a href="/pirk/releasing">Making Releases</a></li> + <li id="nav_nav_verify_release"><a href="/pirk/verifying_releases">Verifying Releases</a></li> + <hr> + <li><a href="https://issues.apache.org/jira/browse/PIRK ">Issue Tracker/JIRA <i class="fa fa-external-link"></i></a></li> + <li><a href="https://builds.apache.org/view/A/view/Accumulo";>Jenkins Builds <i class="fa fa-external-link"></i></a></li> + <li><a href="https://github.com/apache/incubator-pirk";> Pirk Github Mirror <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + <li class="nav-link"><a href="/pirk/roadmap">Roadmap</a></li> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="https://www.apache.org";>Apache Homepage <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";>License <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/sponsorship";>Sponsorship <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/security";>Security <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/thanks";>Thanks <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + </ul> + </ul> + </div> + </div> +</nav> + + + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <div id="content"> + + <h1 class="title">Get Involved</h1> + + <p>You donât need to be a software developer to contribute to Pirk. A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.</p> + +<p>We also highly encourage the involvement of algorithmic team members who provide algorithmic ideas and who may or may not participate in their implementation.</p> + +<h2 id="team">Team</h2> + +<p>The team is comprised of <a href="/pirk/people_pirk">Project Management Committee Members and Contributors</a>. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members.</p> + +<p>The number of Contributors to the project is unbounded - we would love for you to get involved. All contributions to the project are greatly appreciated!</p> + +<h2 id="mailing-lists">Mailing lists</h2> + +<p>To start to get plugged into the project, please check out our <a href="/pirk/mailing_list_pirk">mailing lists</a>.</p> + +<h2 id="meetups">Meetups</h2> + +<p>Check back for meetup listings.</p> + + </div> + + +<footer> + + <p><a href="https://www.apache.org";><img src="/pirk/images/feather-small.gif" alt="Apache Software Foundation" id="asf-logo" height="100" /></a></p> + + <p>Copyright © 2016-2016 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.</p> + +</footer> + + + </div> + </div> + </div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/get_involved_pirk.md ---------------------------------------------------------------------- diff --git a/get_involved_pirk.md b/get_involved_pirk.md deleted file mode 100755 index 075ba3e..0000000 --- a/get_involved_pirk.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Get Involved -nav: nav_getinvolvedpirk ---- - -You donât need to be a software developer to contribute to Pirk. A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions. - -We also highly encourage the involvement of algorithmic team members who provide algorithmic ideas and who may or may not participate in their implementation. - -## Team - -The team is comprised of [Project Management Committee Members and Contributors]({{ site.baseurl }}/people_pirk). Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. - -The number of Contributors to the project is unbounded - we would love for you to get involved. All contributions to the project are greatly appreciated! - -## Mailing lists - -To start to get plugged into the project, please check out our [mailing lists]({{ site.baseurl }}/mailing_list_pirk). - -## Meetups - -Check back for meetup listings. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html new file mode 100644 index 0000000..9283a79 --- /dev/null +++ b/index.html @@ -0,0 +1,277 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<!-- + 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. +--> +<meta charset="utf-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link href="/pirk/css/bootstrap.min.css" rel="stylesheet"> +<link href="/pirk/css/bootstrap-theme.min.css" rel="stylesheet"> +<link href="/pirk/css/dataTables.bootstrap.css" rel="stylesheet"> +<link href="/pirk/css/pirk.css" rel="stylesheet" type="text/css"> +<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + +<title>Apache Pirk (incubating)</title> + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js";></script> +<script src="/pirk/js/bootstrap.min.js"></script> +<script src="/pirk/js/jquery.dataTables.min.js"></script> +<script src="/pirk/js/dataTables.bootstrap.js"></script> +<script> + // show location of canonical site if not currently on the canonical site + $(function() { + var host = window.location.host; + if (typeof host !== 'undefined' && host !== 'pirk.incubator.apache.org') { + $('#non-canonical').show(); + } + }); + + + // decorate menu with currently navigated page + $(function() { + $("#nav_index").addClass("active"); + }); + + + $(function() { + // decorate section headers with anchors + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, icon, id; + $el = $(el); + id = $el.attr('id'); + icon = '<i class="fa fa-link"></i>'; + if (id) { + return $el.append($("<a />").addClass("header-link").attr("href", "#" + id).html(icon)); + } + }); + }); + + // configure Google Analytics + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + if (ga.hasOwnProperty('loaded') && ga.loaded === true) { + ga('create', 'UA-50934829-1', 'apache.org'); + ga('send', 'pageview'); + } +</script> +</head> +<body style="padding-top: 100px"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/pirk/"><img id="nav-logo" alt="Apache Pirk" class="img-responsive" src="/pirk/images/pirkImage.png" width="150"/></a> + </div> + <div class="collapse navbar-collapse" id="navbar-items"> + <ul class="nav navbar-nav"> + <li class="nav-link"><a href="/pirk/downloads">Download</a></li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_users"><a href="/pirk/for_users">For Users</a></li> + <li id="nav_developers"><a href="/pirk/for_developers">For Developers</a></li> + <li id="nav_papers"><a href="/pirk/papers">Papers</a></li> + <li class="nav_faq"><a href="/pirk/faq">FAQ</a></li> + <li class="divider"></li> + <li><a href="/pirk/javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_getinvolvedpirk"><a href="/pirk/get_involved_pirk">Get Involved</a></li> + <li id="nav_listspirk"><a href="/pirk/mailing_list_pirk">Mailing Lists</a></li> + <li id="nav_peoplepirk"><a href="/pirk/people_pirk">People</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Development<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li id="nav_releasing"><a href="/pirk/releasing">Making Releases</a></li> + <li id="nav_nav_verify_release"><a href="/pirk/verifying_releases">Verifying Releases</a></li> + <hr> + <li><a href="https://issues.apache.org/jira/browse/PIRK ">Issue Tracker/JIRA <i class="fa fa-external-link"></i></a></li> + <li><a href="https://builds.apache.org/view/A/view/Accumulo";>Jenkins Builds <i class="fa fa-external-link"></i></a></li> + <li><a href="https://github.com/apache/incubator-pirk";> Pirk Github Mirror <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + <li class="nav-link"><a href="/pirk/roadmap">Roadmap</a></li> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="https://www.apache.org";>Apache Homepage <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/licenses/LICENSE-2.0";>License <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/sponsorship";>Sponsorship <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/security";>Security <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/thanks";>Thanks <i class="fa fa-external-link"></i></a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct <i class="fa fa-external-link"></i></a></li> + </ul> + </li> + </ul> + </ul> + </div> + </div> +</nav> + + + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <div id="content"> + + <div class="row"> + <div class="col-md-2" id="sidebar"> + <br /> + +<table class="table" id="sociallinks"> + <tbody> + <tr> + <td><img src="/pirk/images/Twitter_logo_blue.png" alt="Twitter" style="height: 1em" /></td> + <td><a href="https://twitter.com/apachepirk";>@ApachePirk</a></td> + </tr> + <tr> + <td><img src="/pirk/images/GitHub-Mark-32px.png" alt="GitHub" style="height: 1em" /></td> + <td><a href="https://github.com/apache/incubator-pirk";>apache / incubator-pirk</a></td> + </tr> + </tbody> +</table> + + + <hr /> + <a href="/pirk/news"> News</a> + <br /> + <br /> + +<p><em>June 17, 2016</em></p> + +<p><strong>Apache Pirk enters incubation.</strong></p> + + + <hr /> + <br /> + <a id="apache_incubator_logo" href="http://incubator.apache.org/";><img alt="Apache Incubator" class="img-responsive" src="/pirk/images/apache-incubator-logo.png" /></a> + <br /> + <p style="text-align:center"><img src="/pirk/images/tapir.png" width="60" /></p> + </div> + <div class="col-md-8 col-md-offset-1"> + <br /> + <img alt="Apache Pirk" class="img-responsive" src="/pirk/images/pirkImage.png" width="500" style="margin:0 auto;" /> + <br /> + <br /> + <div class="jumbotron" style="text-align:center"> + <font size="5"><b>Apache Pirk (incubating) is a framework for scalable <br /> Private Information Retrieval (PIR).</b></font> + <br /> + <br /> + <a class="btn btn-success" href="downloads/" role="button"><span class="glyphicon glyphicon-download"></span> Get Pirk</a> + </div> + </div> +</div> + +<h2 id="what-is-pirk">What is Pirk?</h2> + +<p>Pirk 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.</p> + +<h2 id="pirk-basics">Pirk Basics</h2> + +<p><a href="https://en.wikipedia.org/wiki/Private_information_retrieval";>Private Information Retrieval</a> (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.</p> + +<p>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).</p> + +<p>Pirk is centered around the <a href="/pirk/for_users#querier">Querier</a> and the <a href="/pirk/for_users#responder">Responder</a>.</p> + +<p>In Pirk, the Querier is responsible for the following:</p> + +<ul> + <li>Generating the encrypted query vectors (representing encrypted questions)</li> + <li>Generating the necessary decryption items for each query vector</li> + <li>Decrypting encrypted query results obtained from the Responder</li> +</ul> + +<p>Once the Querier generates an encrypted query, it must be sent to the Responder.</p> + +<p>In Pirk, the Responder is responsible for the following:</p> + +<ul> + <li>Performing encrypted queries over their target datasets (using encrypted query vectors)</li> + <li>Forming the encrypted query results</li> +</ul> + +<p>The encrypted query results must be sent from the Responder back to the Querier for decryption.</p> + +<p>Pirk employs generic <a href="/pirk/for_users#data-and-query-schemas">data and query schemas</a>, specified via XML files, that are shared between the Querier and Responder to enable flexible and varied data and query types.</p> + +<h2 id="pirk-framework-and-algorithms">Pirk Framework and Algorithms</h2> + +<p>The Pirk framework is centered around the Querier and Responder; key supporting elements include generic query and data schemas, encryption/decryption, query/response, and in-memory and distributed testing components.</p> + +<p>Pirk is seeded with the Wideskies PIR algorithm which employs <a href="/pirk/papers/1999_asiacrypt_paillier_paper.pdf">Paillier homomorphic encryption</a>; the Wideskies white paper can be found <a href="/pirk/papers/wideskies_paper.pdf">here</a>.</p> + +<h2 id="getting-started">Getting Started</h2> + +<p>Pirk can be downloaded <a href="/pirk/downloads">here</a></p> + +<p>Pirk is written in Java and uses a Maven build system. Dependencies can be found in the pom.xml file and include <a href="http://hadoop.apache.org/";>Apache Hadoop</a>, <a href="http://spark.apache.org/";>Apache Spark</a>, and <a href="https://github.com/elastic/elasticsearch";>Elasticsearch</a>. Currently, Pirk may be utilized in a distributed Hadoop/MapReduce or Spark framework as well as in standalone mode.</p> + +<p>Pirk is seeded with the Wideskies PIR algorithm; please check out the <a href="/pirk/papers/wideskies_paper.pdf">white paper</a></p> + +<p>If you are a User, please check out the <a href="/pirk/for_users">For Users</a> section.</p> + +<p>If you are a Developer, please check out the <a href="/pirk/for_developers">For Developers</a> section.</p> + +<h2 id="community">Community</h2> + +<p>Please check out our <a href="/pirk/get_involved">community</a> section.</p> + +<h2 id="roadmap">Roadmap</h2> + +<p>Please check out our <a href="/pirk/roadmap">Roadmap</a>.</p> + +<h2 id="disclaimer">Disclaimer</h2> + +<p>Apache Pirk (incubating) 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.</p> + + + </div> + + +<footer> + + <p><a href="https://www.apache.org";><img src="/pirk/images/feather-small.gif" alt="Apache Software Foundation" id="asf-logo" height="100" /></a></p> + + <p>Copyright © 2016-2016 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>.</p> + + <p>Apache Pirk (incubating), Apache, and the Apache feather logo, are trademarks of the <a href="https://www.apache.org";>Apache Software Foundation</a>.</p> + +</footer> + + + </div> + </div> + </div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/b96293a9/index.md ---------------------------------------------------------------------- diff --git a/index.md b/index.md deleted file mode 100755 index 27f01bc..0000000 --- a/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Apache Pirk (incubating) -skiph1fortitle: true -nav: nav_index -legal_notice: Apache Pirk (incubating), Apache, and the Apache feather logo, are trademarks of the [Apache Software Foundation](https://www.apache.org). ---- - -<div class="row"> - <div class="col-md-2" id="sidebar"> - <br> - {% capture social-include %}{% include social.md %}{% endcapture %}{{ social-include | markdownify }} - <hr> - <a href="{{ site.baseurl }}/news"> News</a> - <br> - <br> - {% capture newsfeed-include %}{% include newsfeed.md %}{% endcapture %}{{ newsfeed-include | markdownify }} - <hr> - <br> - <a id="apache_incubator_logo" href="http://incubator.apache.org/";><img alt="Apache Incubator" class="img-responsive" src="{{ site.baseurl }}/images/apache-incubator-logo.png"></a> - <br> - <p style="text-align:center"><img src="{{ site.baseurl }}/images/tapir.png" width="60"/></p> - </div> - <div class="col-md-8 col-md-offset-1"> - <br> - <img alt="Apache Pirk" class="img-responsive" src="{{ site.baseurl }}/images/pirkImage.png" width="500" style="margin:0 auto;"/> - <br> - <br> - <div class="jumbotron" style="text-align:center"> - <font size="5"><b>Apache Pirk (incubating) is a framework for scalable <br> Private Information Retrieval (PIR).</b></font> - <br> - <br> - <a class="btn btn-success" href="downloads/" role="button"><span class="glyphicon glyphicon-download"></span> Get Pirk</a> - </div> - </div> -</div> - -## What is Pirk? - -Pirk 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. - -## 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]({{ site.baseurl }}/for_users#querier) and the [Responder]({{ site.baseurl }}/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]({{ site.baseurl }}/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. - -## Pirk Framework and Algorithms - -The Pirk framework is centered around the Querier and Responder; key supporting elements include generic query and data schemas, encryption/decryption, query/response, and in-memory and distributed testing components. - -Pirk is seeded with the Wideskies PIR algorithm which employs [Paillier homomorphic encryption]({{ site.baseurl }}/papers/1999_asiacrypt_paillier_paper.pdf); the Wideskies white paper can be found [here]({{ site.baseurl }}/papers/wideskies_paper.pdf). - -## Getting Started - -Pirk can be downloaded [here]({{ site.baseurl }}/downloads) - -Pirk is written in Java and uses a Maven build system. 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. - -Pirk is seeded with the Wideskies PIR algorithm; please check out the [white paper]({{ site.baseurl }}/papers/wideskies_paper.pdf) - -If you are a User, please check out the [For Users]({{ site.baseurl }}/for_users) section. - -If you are a Developer, please check out the [For Developers]({{ site.baseurl }}/for_developers) section. - -## Community - -Please check out our [community]({{ site.baseurl }}/get_involved) section. - -## Roadmap - -Please check out our [Roadmap]({{ site.baseurl }}/roadmap). - -## Disclaimer - -Apache Pirk (incubating) 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. - \ No newline at end of file
