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
|
# Copyright (C) 2010, 2011 Linaro Limited
#
# Author: Zygmunt Krynicki <zygmunt.krynicki@linaro.org>
#
# SPDX-License-Identifier: GPL-2.0-or-later
"""
XML-RPC views
"""
import base64
from django.conf import settings
from django.contrib.auth.decorators import login_required
from django.contrib.sites.models import Site
from django.http import HttpResponse, HttpResponseRedirect
from django.shortcuts import get_object_or_404, redirect, render
from django.urls import reverse
from django.views.decorators.csrf import csrf_exempt
from lava_server.bread_crumbs import BreadCrumb, BreadCrumbTrail
from lava_server.views import index as lava_index
from linaro_django_xmlrpc.forms import AuthTokenForm
from linaro_django_xmlrpc.models import AuthToken, CallContext, Dispatcher, SystemAPI
@csrf_exempt
def handler(request, mapper, help_view):
"""
XML-RPC handler.
If post data is defined, it assumes it's XML-RPC and tries to process as
such. Empty POST request and GET requests assumes you're viewing from a
browser and tells you about the service by redirecting you to a dedicated
help page. For backwards compatibility the help view defaults to the
'default_help' that shows what is registered in the global mapper. If you
want to show help specific to your mapper you must specify help_view. It
accepts whatever django.shortcuts.redirect() would.
"""
if len(request.body) == 0 or request.method != "POST":
return redirect(help_view)
raw_data = request.body
dispatcher = Dispatcher(mapper)
auth_string = request.META.get("HTTP_AUTHORIZATION")
if auth_string is not None:
if " " not in auth_string:
return HttpResponse("Invalid HTTP_AUTHORIZATION header", status=400)
scheme, value = auth_string.split(" ", 1)
if scheme != "Basic":
return HttpResponse(
"Unsupported HTTP_AUTHORIZATION header, only Basic scheme is supported",
status=400,
)
try:
decoded_value = base64.standard_b64decode(value).decode("utf-8")
except (TypeError, UnicodeDecodeError):
return HttpResponse(
"Corrupted HTTP_AUTHORIZATION header, bad base64 encoding",
status=400,
)
try:
username, secret = decoded_value.split(":", 1)
except ValueError:
return HttpResponse(
"Corrupted HTTP_AUTHORIZATION header, no user:pass", status=400
)
user = AuthToken.get_user_for_secret(username, secret)
if user is None:
response = HttpResponse("Invalid token", status=401)
response["WWW-Authenticate"] = 'Basic realm="XML-RPC Authentication token"'
return response
else:
user = request.user
result = dispatcher.marshalled_dispatch(raw_data, user, request)
response = HttpResponse(content_type="application/xml; charset=utf-8")
response.write(result)
response["Content-length"] = str(len(response.content))
return response
@BreadCrumb("API help", parent=lava_index)
def help(request, mapper, template_name="linaro_django_xmlrpc/api.html"):
context = CallContext(user=None, mapper=mapper, dispatcher=None)
system = SystemAPI(context)
if settings.HTTPS_XML_RPC:
scheme = "https"
else:
scheme = request.META.get("REQUEST_SCHEME", "http")
scheduler_methods = []
results_methods = []
system_methods = []
for method in system.listMethods():
if "scheduler" in method:
scheduler_methods.append(method)
elif "results" in method:
results_methods.append(method)
else:
system_methods.append(method)
methods = {
"scheduler": [
{
"name": method,
"section": method.rsplit(".", 1)[0] if "." in method else "",
"signature": system.methodSignature(method),
"help": system.methodHelp(method),
}
for method in scheduler_methods
],
"results": [
{
"name": method,
"signature": system.methodSignature(method),
"help": system.methodHelp(method),
}
for method in results_methods
],
"system": [
{
"name": method,
"signature": system.methodSignature(method),
"help": system.methodHelp(method),
}
for method in system_methods
],
}
scheduler_method_sections = sorted(
{block["section"] for block in methods["scheduler"]}
)
scheduler_section_methods = {section: [] for section in scheduler_method_sections}
for section in scheduler_method_sections:
if section:
for method in methods["scheduler"]:
if method["section"] == section:
scheduler_section_methods[section].append(method["name"])
domain = Site.objects.get_current().domain
return render(
request,
template_name,
{
"methods": methods,
"scheduler_section_methods": scheduler_section_methods,
"context_help": ["data-export"],
"bread_crumb_trail": BreadCrumbTrail.leading_to(help),
"site_scheme": scheme,
"site_domain": domain,
"site_url": f"{scheme}://{domain}",
},
)
@BreadCrumb("API tokens", parent=lava_index)
@login_required
def tokens(request):
"""
List of tokens for an authenticated user
"""
token_list = AuthToken.objects.filter(user=request.user).order_by("last_used_on")
unused = AuthToken.objects.filter(
user=request.user, last_used_on__isnull=True
).count()
return render(
request,
"linaro_django_xmlrpc/tokens.html",
{
"token_list": token_list,
"unused": unused,
"bread_crumb_trail": BreadCrumbTrail.leading_to(tokens),
"context_help": ["first_steps"],
},
)
@login_required
def create_token(request):
"""
Create a token for the requesting user
"""
if request.method == "POST":
form = AuthTokenForm(request.POST)
if form.is_valid():
form.save(commit=False)
form.instance.user = request.user
form.instance.save()
return HttpResponseRedirect(reverse("linaro_django_xmlrpc_tokens"))
else:
form = AuthTokenForm()
return render(request, "linaro_django_xmlrpc/create_token.html", {"form": form})
@login_required
def delete_token(request, object_id):
token = get_object_or_404(AuthToken, pk=object_id, user=request.user)
if request.method == "POST":
token.delete()
return HttpResponseRedirect(reverse("linaro_django_xmlrpc_tokens"))
return render(
request, "linaro_django_xmlrpc/authtoken_confirm_delete.html", {"token": token}
)
@login_required
def edit_token(request, object_id):
token = get_object_or_404(AuthToken, pk=object_id, user=request.user)
if request.method == "POST":
form = AuthTokenForm(request.POST, instance=token)
if form.is_valid():
form.save()
return HttpResponseRedirect(reverse("linaro_django_xmlrpc_tokens"))
else:
form = AuthTokenForm(instance=token)
return render(
request, "linaro_django_xmlrpc/edit_token.html", {"token": token, "form": form}
)
@login_required
def delete_unused_tokens(request):
token_list = AuthToken.objects.filter(user=request.user, last_used_on__isnull=True)
if request.method == "POST":
for token in token_list:
token.delete()
return HttpResponseRedirect(reverse("linaro_django_xmlrpc_tokens"))
return render(
request,
"linaro_django_xmlrpc/tokens.html",
{"token_list": token_list, "context_help": ["lava-tool"]},
)
|