File: middleware.rst

package info (click to toggle)
swift 2.10.2-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 11,716 kB
  • ctags: 11,366
  • sloc: python: 143,645; sh: 617; pascal: 243; makefile: 71; xml: 30
file content (270 lines) | stat: -rw-r--r-- 5,039 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
.. _common_middleware:

**********
Middleware
**********

Account Quotas
==============

.. automodule:: swift.common.middleware.account_quotas
    :members:
    :show-inheritance:

.. _bulk:

Bulk Operations (Delete and Archive Auto Extraction)
====================================================

.. automodule:: swift.common.middleware.bulk
    :members:
    :show-inheritance:

.. _catch_errors:

CatchErrors
=============

.. automodule:: swift.common.middleware.catch_errors
    :members:
    :show-inheritance:

CNAME Lookup
============

.. automodule:: swift.common.middleware.cname_lookup
    :members:
    :show-inheritance:

.. _container-quotas:

Container Quotas
================

.. automodule:: swift.common.middleware.container_quotas
    :members:
    :show-inheritance:

.. _container-sync:

Container Sync Middleware
=========================

.. automodule:: swift.common.middleware.container_sync
    :members:
    :show-inheritance:

Cross Domain Policies
=====================

.. automodule:: swift.common.middleware.crossdomain
    :members:
    :show-inheritance:

.. _discoverability:

Discoverability
===============

Swift will by default provide clients with an interface providing details
about the installation. Unless disabled (i.e ``expose_info=false`` in
:ref:`proxy-server-config`), a GET request to ``/info`` will return configuration
data in JSON format.  An example response::

    {"swift": {"version": "1.11.0"}, "staticweb": {}, "tempurl": {}}

This would signify to the client that swift version 1.11.0 is running and that
staticweb and tempurl are available in this installation.

There may be administrator-only information available via ``/info``. To
retrieve it, one must use an HMAC-signed request, similar to TempURL.
The signature may be produced like so::

    swift-temp-url GET 3600 /info secret 2>/dev/null | sed s/temp_url/swiftinfo/g

Domain Remap
============

.. automodule:: swift.common.middleware.domain_remap
    :members:
    :show-inheritance:

Dynamic Large Objects
=====================

DLO support centers around a user specified filter that matches
segments and concatenates them together in object listing order. Please see
the DLO docs for :ref:`dlo-doc` further details.

.. _encryption:

Encryption
==========

Encryption middleware should be deployed in conjunction with the
:ref:`keymaster` middleware.

.. automodule:: swift.common.middleware.crypto
    :members:
    :show-inheritance:

.. automodule:: swift.common.middleware.crypto.encrypter
    :members:
    :show-inheritance:

.. automodule:: swift.common.middleware.crypto.decrypter
    :members:
    :show-inheritance:

.. _formpost:

FormPost
========

.. automodule:: swift.common.middleware.formpost
    :members:
    :show-inheritance:

.. _gatekeeper:

GateKeeper
==========

.. automodule:: swift.common.middleware.gatekeeper
    :members:
    :show-inheritance:

.. _healthcheck:

Healthcheck
===========

.. automodule:: swift.common.middleware.healthcheck
    :members:
    :show-inheritance:

.. _keymaster:

Keymaster
=========

Keymaster middleware should be deployed in conjunction with the
:ref:`encryption` middleware.

.. automodule:: swift.common.middleware.crypto.keymaster
    :members:
    :show-inheritance:

.. _keystoneauth:

KeystoneAuth
============

.. automodule:: swift.common.middleware.keystoneauth
    :members:
    :show-inheritance:

.. _list_endpoints:

List Endpoints
==============

.. automodule:: swift.common.middleware.list_endpoints
    :members:
    :show-inheritance:

Memcache
========

.. automodule:: swift.common.middleware.memcache
    :members:
    :show-inheritance:

Name Check (Forbidden Character Filter)
=======================================

.. automodule:: swift.common.middleware.name_check
    :members:
    :show-inheritance:

.. _versioned_writes:

Object Versioning
=================

.. automodule:: swift.common.middleware.versioned_writes
    :members:
    :show-inheritance:

Proxy Logging
=============

.. automodule:: swift.common.middleware.proxy_logging
    :members:
    :show-inheritance:

Ratelimit
=========

.. automodule:: swift.common.middleware.ratelimit
    :members:
    :show-inheritance:

.. _recon:

Recon
===========

.. automodule:: swift.common.middleware.recon
    :members:
    :show-inheritance:

.. _copy:

Server Side Copy
================

.. automodule:: swift.common.middleware.copy
    :members:
    :show-inheritance:

Static Large Objects
====================

Please see
the SLO docs for :ref:`slo-doc` further details.


.. _staticweb:

StaticWeb
=========

.. automodule:: swift.common.middleware.staticweb
    :members:
    :show-inheritance:

.. _common_tempauth:

TempAuth
========

.. automodule:: swift.common.middleware.tempauth
    :members:
    :show-inheritance:

.. _tempurl:

TempURL
=======

.. automodule:: swift.common.middleware.tempurl
    :members:
    :show-inheritance:

XProfile
==============

.. automodule:: swift.common.middleware.xprofile
    :members:
    :show-inheritance: