Current File : //usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyo
�
���^c @@ sL d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z i d d 6d d 6d d 6d
d 6d d
6d d 6d d 6Z d Z e j
e � Z d � Z d e f d � � YZ d � Z d � Z d � Z d d � Z d � Z d � Z d � Z d � Z d � Z d � Z e d k rHe � n d S(! u�
A minimalist REST API for Salt
==============================
This ``rest_wsgi`` module provides a no-frills REST interface for sending
commands to the Salt master. There are no dependencies.
Extra care must be taken when deploying this module into production. Please
read this documentation in entirety.
All authentication is done through Salt's :ref:`external auth <acl-eauth>`
system.
Usage
=====
* All requests must be sent to the root URL (``/``).
* All requests must be sent as a POST request with JSON content in the request
body.
* All responses are in JSON.
.. seealso:: :py:mod:`rest_cherrypy <salt.netapi.rest_cherrypy.app>`
The :py:mod:`rest_cherrypy <salt.netapi.rest_cherrypy.app>` module is
more full-featured, production-ready, and has builtin security features.
Deployment
==========
The ``rest_wsgi`` netapi module is a standard Python WSGI app. It can be
deployed one of two ways.
Using a WSGI-compliant web server
---------------------------------
This module may be run via any WSGI-compliant production server such as Apache
with mod_wsgi or Nginx with FastCGI.
It is strongly recommended that this app be used with a server that supports
HTTPS encryption since raw Salt authentication credentials must be sent with
every request. Any apps that access Salt through this interface will need to
manually manage authentication credentials (either username and password or a
Salt token). Tread carefully.
:program:`salt-api` using a development-only server
---------------------------------------------------
If run directly via the salt-api daemon it uses the `wsgiref.simple_server()`__
that ships in the Python standard library. This is a single-threaded server
that is intended for testing and development. **This server does not use
encryption**; please note that raw Salt authentication credentials must be sent
with every HTTP request.
**Running this module via salt-api is not recommended!**
In order to start this module via the ``salt-api`` daemon the following must be
put into the Salt master config::
rest_wsgi:
port: 8001
.. __: http://docs.python.org/2/library/wsgiref.html#module-wsgiref.simple_server
Usage examples
==============
.. http:post:: /
**Example request** for a basic ``test.ping``::
% curl -sS -i \
-H 'Content-Type: application/json' \
-d '[{"eauth":"pam","username":"saltdev","password":"saltdev","client":"local","tgt":"*","fun":"test.ping"}]' localhost:8001
**Example response**:
.. code-block:: http
HTTP/1.0 200 OK
Content-Length: 89
Content-Type: application/json
{"return": [{"ms--4": true, "ms--3": true, "ms--2": true, "ms--1": true, "ms--0": true}]}
**Example request** for an asynchronous ``test.ping``::
% curl -sS -i \
-H 'Content-Type: application/json' \
-d '[{"eauth":"pam","username":"saltdev","password":"saltdev","client":"local_async","tgt":"*","fun":"test.ping"}]' localhost:8001
**Example response**:
.. code-block:: http
HTTP/1.0 200 OK
Content-Length: 103
Content-Type: application/json
{"return": [{"jid": "20130412192112593739", "minions": ["ms--4", "ms--3", "ms--2", "ms--1", "ms--0"]}]}
**Example request** for looking up a job ID::
% curl -sS -i \
-H 'Content-Type: application/json' \
-d '[{"eauth":"pam","username":"saltdev","password":"saltdev","client":"runner","fun":"jobs.lookup_jid","jid":"20130412192112593739"}]' localhost:8001
**Example response**:
.. code-block:: http
HTTP/1.0 200 OK
Content-Length: 89
Content-Type: application/json
{"return": [{"ms--4": true, "ms--3": true, "ms--2": true, "ms--1": true, "ms--0": true}]}
:form lowstate: A list of lowstate data appropriate for the
:ref:`client <client-apis>` interface you are calling.
:status 200: success
:status 401: authentication required
i ( t absolute_importt print_functiont unicode_literalsNu 200 OKi� u 400 BAD REQUESTi� u 401 UNAUTHORIZEDi� u
404 NOT FOUNDi� u 405 METHOD NOT ALLOWEDi� u 406 NOT ACCEPTABLEi� u 500 INTERNAL SERVER ERRORi� u rest_wsgic C@ s& t j t i � } d | k r" t St S( Nu port( t __opts__t gett __virtualname__t False( t mod_opts( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt __virtual__� s t HTTPErrorc B@ s e Z d Z d � Z RS( uM
A custom exception that can take action based on an HTTP error code
c C@ s) | | _ t j | d j | | � � d S( Nu {0}: {1}( t codet Exceptiont __init__t format( t selfR
t message( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyR � s ( t __name__t
__module__t __doc__R ( ( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyR � s c C@ sU y t j | � Wn= t k
rP } | j t j k rJ t j j | � rJ qQ � n Xd S( u?
mkdir -p
http://stackoverflow.com/a/600612/127816
N( t ost makedirst OSErrort errnot EEXISTt patht isdir( R t exc( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt mkdir_p� s $c C@ sA | j d d � } | d k r$ d n t | � } | d j | � S( u6
Pull the body from the request and return it
u CONTENT_LENGTHu 0u i u
wsgi.input( R t intt read( t environt length( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt read_body� s c C@ sv | j d d � } | d k r0 t d d � � n y t j j j t | � � SWn" t k
rq } t d | � � n Xd S( u)
Return the request body as JSON
u CONTENT_TYPEu u application/jsoni� u
JSON requiredi� N( R R t saltt utilst jsont loadsR t
ValueError( R t content_typeR ( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt get_json� s c C@ s? i t t | � � d 6} | r/ | j | � n t | j � � S( u�
Takes the response data as well as any additional headers and returns a
tuple of tuples of headers suitable for passing to start_response()
u Content-Length( t strt lent updatet listt items( t datat
extra_headerst response_headers( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt get_headers� s
c c@ s- | d } x | D] } | j | � Vq Wd S( u]
Expects a list of lowstate dictionaries that are executed and returned in
order
u SALT_APIClientN( t run( R t lowstatet clientt chunk( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt run_chunk� s
c C@ sX | d j � } | d k r d S| d k rE t | � } t | | � St d d � � d S( u|
Do any path/method dispatching here and return a JSON-serializable data
structure appropriate for the response
u REQUEST_METHODu GETuF They found me. I don't know how, but they found me. Run for it, Marty!u POSTi� u Method Not AllowedN( t upperR' R5 R ( R t methodR- ( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt dispatch� s
c C@ sc d t � k r? d d l } | j j t j j d d � � } n | | d <| j j | � | d <d S( uO
Make Salt's opts dict and the APIClient available in the WSGI environ
u __opts__i Nu SALT_MASTER_CONFIGu /etc/salt/masteru SALT_OPTSu SALT_APIClient( t localst salt.configt configt
client_configR R R t netapit NetapiClient( R R! R ( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt saltenviron� s
c C@ s t | � y t t | � � } d } Wnv t k
rP } | j } t | � } nO t j j k
rz } d } t | � } n% t k
r� } d } t | � } n Xy t j
j j i | d 6� } Wn% t
k
r� } d } t | � } n X| t | t | i d d 6� � | f S( up
Process the request and return a JSON response. Catch errors and return the
appropriate HTTP code.
i� i� i� u returnu application/jsonu Content-Type( R? R+ R8 R R
R( R! t
exceptionst EauthAuthenticationErrorR R" R# t dumpst TypeErrort HR0 ( R t start_responset respR
R t ret( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt application s*
c C@ s+ d d l } | j j t j j d d � � S( u3
Return the Salt master config as __opts__
i Nu SALT_MASTER_CONFIGu /etc/salt/master( R: R; R< R R R ( R! ( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt get_opts* s c C@ s� d d l m } d t � k rP t � t � d <t � t k rP t d � � qP n t j t i � } | d | d t
� } y | j � Wn t k
r� t d � � n Xd S( u
Start simple_server()
i ( t make_serveru __opts__i u localhostu portN(
t wsgiref.simple_serverRJ t globalsRI R R t
SystemExitR R R RH t
serve_forevert KeyboardInterrupt( RJ R t httpd( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt start4 s
u __main__( R t
__future__R R R R t loggingR R! t salt.netapit salt.utils.jsonRD R t getLoggert loggerR R R R R R' t NoneR0 R5 R8 R? RH RI RQ R ( ( ( s9 /usr/lib/python2.7/site-packages/salt/netapi/rest_wsgi.pyt <module>{ s>
$
Mini Shell