You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2014/03/08 15:46:14 UTC

[02/18] git commit: Moved S3 auth docs from README to Sphinx

Moved S3 auth docs from README to Sphinx


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/f319707d
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/f319707d
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/f319707d

Branch: refs/heads/master
Commit: f319707dc452f67510699e6d0ffb563357458671
Parents: d31e65d
Author: Leif Hedstrom <zw...@apache.org>
Authored: Fri Mar 7 22:18:50 2014 +0000
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Sat Mar 8 07:45:48 2014 -0700

----------------------------------------------------------------------
 doc/reference/plugins/index.en.rst   |  1 +
 doc/reference/plugins/s3_auth.en.rst | 84 +++++++++++++++++++++++++++++++
 plugins/experimental/s3_auth/README  | 58 ---------------------
 3 files changed, 85 insertions(+), 58 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f319707d/doc/reference/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/index.en.rst b/doc/reference/plugins/index.en.rst
index 20feb63..275411d 100644
--- a/doc/reference/plugins/index.en.rst
+++ b/doc/reference/plugins/index.en.rst
@@ -71,6 +71,7 @@ directory of the Apache Traffic Server source tree. Exmperimental plugins can be
   hipes.en
   metalink.en
   mysql_remap.en
+  s3_auth.en
   stale_while_revalidate.en
   ts_lua.en
   xdebug.en

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f319707d/doc/reference/plugins/s3_auth.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/s3_auth.en.rst b/doc/reference/plugins/s3_auth.en.rst
new file mode 100644
index 0000000..38861d5
--- /dev/null
+++ b/doc/reference/plugins/s3_auth.en.rst
@@ -0,0 +1,84 @@
+.. _s3-auth-plugin:
+
+AWS S3 Authentication plugin
+****************************
+
+.. 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.
+
+
+This is a plugin for Apache Traffic Server that provides support for the
+``Amazon S3`` authentication features. This is useful if you for example want
+to use ``S3`` as your origin server, yet want to avoid direct user access to
+the content.
+
+Using the plugin
+----------------
+
+There are three configuration options for this plugin::
+
+    --access_key    <key>
+    --secret_key    <key>
+    --virtual_host
+    --config        <config file>
+
+
+Using the first two in a remap rule would be e.g.::
+
+   ...  @plugin=s3_auth @pparam=--access_key @pparam=my-key \
+                        @pparam=--secret_key @pparam=my-secret \
+			@pparam=--virtual_host
+
+
+Alternatively, you can store the access key and secret in an external
+configuration file, and point the remap rule(s) to it:
+
+   ...  @plugin=s3_auth @pparam=--config @pparam=s3.config
+
+
+Where s3.config would look like::
+
+    # AWS S3 authentication
+        access_key=my-key
+        secret_key=my-secret
+        virtual_host=yes
+
+
+For more details on the S3 auth, see::
+
+  http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
+
+
+ToDo
+----
+
+This is a pretty barebone start for the S3 services, it is missing a number of features:
+
+- It does not do UTF8 encoding (as required)
+
+- It only implements the v2 authentication mechanism. For details on v4, see
+
+  http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
+
+- It does not deal with canonicalization of AMZ headers.
+
+- It does not handle POST requests (but do we need to ?)
+
+- It does not incorporate query parameters.
+
+
+Contributions to any of these would be appreciated.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f319707d/plugins/experimental/s3_auth/README
----------------------------------------------------------------------
diff --git a/plugins/experimental/s3_auth/README b/plugins/experimental/s3_auth/README
deleted file mode 100644
index 18a2f3f..0000000
--- a/plugins/experimental/s3_auth/README
+++ /dev/null
@@ -1,58 +0,0 @@
-AWS S3 Authentication plugin
-----------------------------
-
-This plugin implements a basic AWS S3 authentication feature for Apache
-Traffic Server. This allows for URLs to be signed before sending to the S3
-services, typically acting as origin servers.
-
-Configuration
--------------
-
-There are three configuration options for this plugin:
-
-    --access_key  <key>
-    --secret_key  <key>
-    --virtual_host
-    --config      <config file>
-
-
-Using the first two in a remap rule would be e.g.
-
-   ...  @plugin=s3_auth @pparam=--access_key @pparam=my-key \
-                        @pparam=--secret_key @pparam=my-secret \
-			@pparam=--virtual_host
-
-
-Alternatively, you can store the access key and secret in an external
-configuration file, and point the remap rule(s) to it:
-
-   ...  @plugin=s3_auth @pparam=--config @pparam=s3.config
-
-
-Where s3.config would look like
-
-    # AWS S3 authentication
-        access_key=my-key
-        secret_key=my-secret
-        virtual_host=yes
-
-
-For more details on the S3 auth, see
-
-  http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
-
-
-ToDo
-----
-
-* It does not do UTF8 encoding (as required)
-
-* It only implements the v2 authentication mechanism. For details on v4, see
-
-  http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
-
-* It does not deal with canonicalization of AMZ headers.
-
-* It does not handle POST requests (do we need to ?)
-
-* It does not incorporate query parameters.