OpsGuide-Customize-ObjectStorage

= Customizing Object Storage (Swift) Middleware =

OpenStack Object Storage, known as swift when reading the code, is based on the Python Paste framework. The best introduction to its architecture is A Do-It-Yourself Framework. Because of the swift project's use of this framework, you are able to add features to a project by placing some custom code in a project's pipeline without having to change any of the core code.

Imagine a scenario where you have public access to one of your containers, but what you really want is to restrict access to that to a set of IPs based on a whitelist. In this example, we'll create a piece of middleware for swift that allows access to a container from only a set of IP addresses, as determined by the container's metadata items. Only those IP addresses that you explicitly whitelist using the container's metadata will be able to access the container.

warning

This example is for illustrative purposes only. It should not be used as a container IP whitelist solution without further development and extensive security testing. When you join the screen session that  starts with , you see a screen for each service running, which can be a few or several, depending on how many services you configured DevStack to run.

The asterisk * indicates which screen window you are viewing. This example shows we are viewing the key (for keystone) screen window:

0$ shell 1$ key*  2$ horizon  3$ s-proxy  4$ s-object  5$ s-container  6$ s-account The purpose of the screen windows are as follows:


 * A shell where you can get some work done
 * A shell where you can get some work done


 * The keystone service
 * The keystone service


 * The horizon dashboard web application
 * The horizon dashboard web application


 * The swift services
 * The swift services

To create the middleware and plug it in through Paste configuration:

All of the code for OpenStack lives in. Go to the swift directory in the  screen and edit your middleware module.

  Change to the directory where Object Storage is installed: $ cd /opt/stack/swift   Create the  Python source code file: $ vim swift/common/middleware/ip_whitelist.py   Copy the code as shown below into. The following code is a middleware example that restricts access to a container based on IP address as explained at the beginning of the section. Middleware passes the request on to another application. This example uses the swift &quot;swob&quot; library to wrap Web Server Gateway Interface (WSGI) requests and responses into objects for swift to interact with. When you're done, save and close the file. There is a lot of useful information in  and   that you can use to decide what to do with the request. To find out more about what properties are available, you can insert the following log statement into the  method: and the following log statement into the  method:   To plug this middleware into the swift Paste pipeline, you edit one configuration file, : $ vim /etc/swift/proxy-server.conf   Find the  section in , and copy in the following configuration section after it:   Find the  section in , and add   after ratelimit to the list like so. When you're done, save and close the file: </li> Restart the  service to make swift use your middleware. Start by switching to the  screen: <ol> Press Ctrl+A followed by 3.</li> Press Ctrl+C to kill the service.</li> Press Up Arrow to bring up the last command.</li> Press Enter to run it.</li></ol> </li> Test your middleware with the  CLI. Start by switching to the shell screen and finish by switching back to the  screen to check the log output: <ol> Press  Ctrl+A followed by 0.</li>  Make sure you're in the  directory: <pre class="sourceCode console">$ cd /root/devstack </li>  Source openrc to set up your environment variables for the CLI: <pre class="sourceCode console">$. openrc </li>  Create a container called : <pre class="sourceCode console">$ swift post middleware-test </li> Press Ctrl+A followed by 3 to check the log output.</li></ol> </li>  Among the log statements you'll see the lines: <pre class="sourceCode none">proxy-server Remote IP: my.instance.ip.address (txn: ...) proxy-server Allow IPs: set(['my.instance.ip.address']) (txn: ...) These two statements are produced by our middleware and show that the request was sent from our DevStack instance and was allowed. </li> Test the middleware from outside DevStack on a remote machine that has access to your DevStack instance: <ol>  Install the  and   clients on your local machine: <pre class="sourceCode console"># pip install python-keystoneclient python-swiftclient </li>  Attempt to list the objects in the  container: <pre class="sourceCode console">$ swift --os-auth-url=http://my.instance.ip.address:5000/v2.0/ \ --os-region-name=RegionOne --os-username=demo:demo \ --os-password=devstack list middleware-test Container GET failed: http://my.instance.ip.address:8080/v1/AUTH_.../ middleware-test?format=json 403 Forbidden   You shall not pass! </li></ol> </li>  Press Ctrl+A followed by 3 to check the log output. Look at the swift log statements again, and among the log statements, you'll see the lines: <pre class="sourceCode console">proxy-server Authorizing from an overriding middleware (i.e: tempurl) (txn: ...) proxy-server ... IPWhitelistMiddleware proxy-server Remote IP: my.local.ip.address (txn: ...) proxy-server Allow IPs: set(['my.instance.ip.address']) (txn: ...) proxy-server IP my.local.ip.address denied access to Account=AUTH_... \  Container=None. Not in set(['my.instance.ip.address']) (txn: ...) Here we can see that the request was denied because the remote IP address wasn't in the set of allowed IPs. </li> <li>Back in your DevStack instance on the shell screen, add some metadata to your container to allow the request from the remote machine: <ol> <li>Press Ctrl+A followed by 0.</li> <li> Add metadata to the container to allow the IP: <pre class="sourceCode console">$ swift post --meta allow-dev:my.local.ip.address middleware-test </li> <li> Now try the command from Step 10 again and it succeeds. There are no objects in the container, so there is nothing to list; however, there is also no error to report. warning Functional testing like this is not a replacement for proper unit and integration testing, but it serves to get you started. </li></ol> </li></ol>

You can follow a similar pattern in other projects that use the Python Paste framework. Simply create a middleware module and plug it in through configuration. The middleware runs in sequence as part of that project's pipeline and can call out to other services as necessary. No project core code is touched. Look for a  value in the project's   or   configuration files in   to identify projects that use Paste.

When your middleware is done, we encourage you to open source it and let the community know on the OpenStack mailing list. Perhaps others need the same functionality. They can use your code, provide feedback, and possibly contribute. If enough support exists for it, perhaps you can propose that it be added to the official swift middleware.