From f69df9845ca00cab46d9bf8cedbbddd81869f252 Mon Sep 17 00:00:00 2001 From: dcore94 Date: Wed, 15 Dec 2021 15:22:30 +0100 Subject: [PATCH] first share of docker instructions --- .muscle/config | 7 + build-docker-images-sh | 1 + cdn-base-swarm.yaml | 62 ++++++++ conf/cdn/auth.json | 24 +++ conf/cdn/d4s-cdn.json | 119 +++++++++++++++ conf/pep/config.js | 67 +++++++++ conf/pep/default.conf | 98 +++++++++++++ conf/pep/nginx.conf | 44 ++++++ conf/pep/pep.js | 322 +++++++++++++++++++++++++++++++++++++++++ images/Dockerfile-cdn | 12 ++ 10 files changed, 756 insertions(+) create mode 100644 .muscle/config create mode 100755 build-docker-images-sh create mode 100644 cdn-base-swarm.yaml create mode 100644 conf/cdn/auth.json create mode 100644 conf/cdn/d4s-cdn.json create mode 100644 conf/pep/config.js create mode 100644 conf/pep/default.conf create mode 100644 conf/pep/nginx.conf create mode 100644 conf/pep/pep.js create mode 100644 images/Dockerfile-cdn diff --git a/.muscle/config b/.muscle/config new file mode 100644 index 0000000..9b176b0 --- /dev/null +++ b/.muscle/config @@ -0,0 +1,7 @@ +{ + "bitbucket" : { + "client-id" : "jFZ9g7zsQxHYt7f57s", + "client-secret" : "#######" + } +} + diff --git a/build-docker-images-sh b/build-docker-images-sh new file mode 100755 index 0000000..bd7949d --- /dev/null +++ b/build-docker-images-sh @@ -0,0 +1 @@ +docker build --rm --no-cache -t nubisware/d4s-cdn -f images/Dockerfile-cdn . diff --git a/cdn-base-swarm.yaml b/cdn-base-swarm.yaml new file mode 100644 index 0000000..0e0370c --- /dev/null +++ b/cdn-base-swarm.yaml @@ -0,0 +1,62 @@ +version: '3.6' + +services: + + pep: + image: nginx:stable-alpine + networks: + - cdn-network + ports: + - "80:80" + deploy: + mode: replicated + replicas: 2 + restart_policy: + condition: on-failure + delay: 10s + window: 120s + configs: + - source: nginxconf + target: /etc/nginx/templates/default.conf.template + - source: nginxbaseconf + target: /etc/nginx/nginx.conf + - source: pep + target: /etc/nginx/pep.js + - source: pepconfig + target: /etc/nginx/config.js + + cdn: + image: nubisware/d4s-cdn + networks: + - cdn-network + deploy: + mode: replicated + replicas: 2 + restart_policy: + condition: on-failure + delay: 10s + window: 200s + configs: + - source: authconf + target: /opt/app/cdn/conf/auth.json + - source: cdnconf + target: /opt/app/cdn/conf/d4s-cdn.json + +networks: + cdn-network: + +configs: + nginxconf: + file: ./conf/pep/default.conf + nginxbaseconf: + file: ./conf/pep/nginx.conf + pep: + file: ./conf/pep/pep.js + pepconfig: + file: ./conf/pep/config.js + + cdnconf: + file: ./conf/cdn/d4s-cdn.json + authconf: + file: ./conf/cdn/auth.json + diff --git a/conf/cdn/auth.json b/conf/cdn/auth.json new file mode 100644 index 0000000..a05a0b8 --- /dev/null +++ b/conf/cdn/auth.json @@ -0,0 +1,24 @@ +{ + + "principal-workflow" : "session-principal", + "login-workflow" : "keycloak", + + "principal-key" : "_PRINCIPAL_", + + "keycloakurl" : "https://accounts.dev.d4science.org", + "keycloakrealm" : "d4science", + + "clientid" : "d4science-example-wp", + "client_redirect_uri" : "http://d4science-cdn-public/d4s-cdn/auth/oidc-callback", + + "user-manager-client-id" : "orchestrator", + "user-manager-client-secret" : "######", + + "client-manager-client-id" : "orchestrator", + "client-manager-client-secret" : "######", + + "group-manager-client-id" : "orchestrator", + "group-manager-client-secret" : "######" + +} + diff --git a/conf/cdn/d4s-cdn.json b/conf/cdn/d4s-cdn.json new file mode 100644 index 0000000..6d824d4 --- /dev/null +++ b/conf/cdn/d4s-cdn.json @@ -0,0 +1,119 @@ +{ + "d4science_realm" : "d4science", + "d4science_iam_base" : "https://accounts.dev.d4science.org/auth", + "infrastructure" : { + "id" : "%2Fgcube", + "name" : "/gcube", + "type" : "root-vo", + "children" : [ + { + "id" : "%2Fgcube%2Fdevsec", + "name" : "/gcube/devsec", + "type" : "vo", + "gateways" : ["d4science-example-wp"], + "about" : "
devsec VO

This VO of the D4Science development infrastructure.

In this VO ...

", + "apps" : [ + { + "id" : "about", + "name" : "About", + "description" : "Welcome message" + }, + { + "id" : "vo-manage", + "name" : "Manage", + "type" : "category", + "apps" : [ + { + "id" : "user-manager", + "name" : "Users", + "description" : "Manage users of VO and roles" + }, + { + "id" : "ext-app-manager", + "name" : "External applications", + "description" : "Manage external applications and roles" + } + ], + "description" : "Manage Virtual Organization" + } + ], + "children" : [ + { + "id" : "%2Fgcube%2Fdevsec%2FdevVRE", + "name" : "/gcube/devsec/devVRE", + "type" : "vre", + "about" : "
/gcube/devsec/devVRE

on gcube dev infrastructure used for ...

", + "apps" : [ + { + "id" : "about", + "name" : "About", + "description" : "Welcome message" + }, + { + "id" : "vre-manage", + "type" : "category", + "name" : "Manage", + "description" : "Manage Virtual Research Environment", + "apps" : [ + { + "id" : "user-manager", + "name" : "Users", + "description" : "Manage users of VRE and roles" + }, + { + "id" : "ext-app-manager", + "name" : "External applications", + "description" : "Manage external applications and roles" + } + ] + }, + { + "id" : "analytics", + "type" : "category", + "name" : "Analytics 2", + "description" : "The new analytics framework", + "icon" : "images/batman.png", + "apps" : [ + { + "id" : "ccp_workflow-manager", + "name" : "Workflows", + "description" : "Manage workflows of analytics engine 2" + } + ] + } + ] + }, + { + "id" : "%2Fgcube%2Fdevsec%2FSAITEST", + "name" : "/gcube/devsec/SAITEST", + "type" : "vre", + "about" : "
/gcube/devsec/SAITEST

/gcube/devsec/SAITEST on gcube dev infrastructure used for ...

", + "apps" : [ + { + "id" : "about", + "name" : "About", + "description" : "Welcome message" + } + ] + }, + { + "id" : "%2Fgcube%2Fdevsec%2FanotherVRE4", + "name" : "/gcube/devsec/anotherVRE4", + "type" : "vre" + } + ] + }, + { + "id" : "%2Fgcube%2FdevNext", + "name" : "/gcube/devNext", + "children" : [ + { + "id" : "%2Fgcube%2FdevNext%2FNextNext", + "name" : "/gcube/devNext/NextNext", + "type" : "vre" + } + ] + } + ] + } +} diff --git a/conf/pep/config.js b/conf/pep/config.js new file mode 100644 index 0000000..e961ddb --- /dev/null +++ b/conf/pep/config.js @@ -0,0 +1,67 @@ +export default { config }; + +var config = { + "pep-credentials" : "########", + "hosts" : [ + { + "host": "d4science-cdn", + "audience" : "d4science-cdn", + "allow-basic-auth" : false, + "paths" : [ + { + "name" : "Default Resource", + "path" : "^/d4s-cdn/config/.+$", + "methods" : [ + { + "method" : "GET", + "scopes" : ["get"] + } + ] + }, + { + "name" : "Default Resource", + "path" : "^/d4s-cdn/visuals/.*$", + "methods" : [ + { + "method" : "GET" + } + ] + }, + { + "name" : "Default Resource", + "path" : "^/d4s-cdn/(?!visuals)(?!config)(?!services).+$", + "methods" : [ + { + "method" : "GET" + } + ] + }, + { + "name" : "Default Resource", + "path" : "^/d4s-cdn/services/.*$", + "methods" : [ + { + "method" : "OPTIONS" + }, + { + "method" : "POST" + }, + { + "method" : "HEAD" + }, + { + "method" : "PUT" + }, + { + "method" : "DELETE" + }, + { + "method" : "GET" + } + ] + } + ] + } + ] +} + diff --git a/conf/pep/default.conf b/conf/pep/default.conf new file mode 100644 index 0000000..6c4fe8a --- /dev/null +++ b/conf/pep/default.conf @@ -0,0 +1,98 @@ +upstream d4science-cdn { + ip_hash; + server cdn:8984; +} + +js_var $auth_token; +js_var $pep_credentials; +js_var $user; +js_var $user_display; + +map $http_authorization $source_auth { + default ""; +} + +server { + + listen *:80; + listen [::]:80; + server_name d4science-cdn; + + subrequest_output_buffer_size 200k; + + location /d4s-cdn/config/ { + proxy_pass http://d4science-cdn; + } + + location / { + if ($request_method = OPTIONS) { + add_header Access-Control-Allow-Origin '*'; + add_header Access-Control-Allow-Methods 'GET, POST, PUT, DELETE, OPTIONS'; + add_header Content-Type text/plain; + add_header Access-Control-Allow-Headers "Content-Type, Authorization, Accept, Origin"; + add_header Content-Length 0; + return 204; + } + js_content pep.enforce; + } + + location /resources/ { + proxy_pass http://d4science-cdn; + } + + location @backend { + add_header Access-Control-Allow-Origin *; + add_header Access-Control-Allow-Methods "GET, POST, OPTIONS"; + add_header Access-Control-Allow-Headers "Content-Type, Authorization, Accept, Origin"; + proxy_set_header Authorization "Bearer $auth_token"; + proxy_set_header X-User "$user"; + proxy_set_header X-User-display "$user_display"; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Host $host; + proxy_set_header X-Forwarded-Server $host; + proxy_set_header X-Forwarded-Port $server_port; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Original-URI $request_uri; + proxy_pass http://d4science-cdn; + } + + location /jwt_verify_request { + internal; + gunzip on; + proxy_method POST; + proxy_http_version 1.1; + proxy_set_header Authorization $pep_credentials; + proxy_set_header Content-Type "application/x-www-form-urlencoded"; + proxy_pass https://accounts.dev.d4science.org/auth/realms/d4science/protocol/openid-connect/token/introspect; + + proxy_cache token_responses; # Enable caching + proxy_cache_key $source_auth; # Cache for each source authentication + proxy_cache_lock on; # Duplicate tokens must wait + proxy_cache_valid 200 10s; # How long to use each response + proxy_ignore_headers Cache-Control Expires Set-Cookie; + } + + location /jwt_request { + internal; + gunzip on; + proxy_method POST; + proxy_http_version 1.1; + proxy_set_header Authorization $pep_credentials; + proxy_set_header Content-Type "application/x-www-form-urlencoded"; + proxy_pass https://accounts.dev.d4science.org/auth/realms/d4science/protocol/openid-connect/token; + } + + location /permission_request { + internal; + gunzip on; + proxy_method POST; + proxy_http_version 1.1; + proxy_set_header Content-Type "application/x-www-form-urlencoded"; + proxy_set_header Authorization "Bearer $auth_token"; + proxy_pass https://accounts.dev.d4science.org/auth/realms/d4science/protocol/openid-connect/token; + } + +} + diff --git a/conf/pep/nginx.conf b/conf/pep/nginx.conf new file mode 100644 index 0000000..5796bf6 --- /dev/null +++ b/conf/pep/nginx.conf @@ -0,0 +1,44 @@ +# Added to load njs module +load_module modules/ngx_http_js_module.so; + +user nginx; +worker_processes auto; + +error_log /var/log/nginx/error.log notice; +pid /var/run/nginx.pid; + + +events { + worker_connections 1024; +} + + +http { + + # added to import pep script + js_import pep.js; + + # added to bind enforce function + js_set $authorization pep.enforce; + + # added to create cache for tokens and auth calls + proxy_cache_path /var/cache/nginx/pep keys_zone=token_responses:1m max_size=2m; + + include /etc/nginx/mime.types; + default_type application/octet-stream; + + log_format main '$remote_addr - $remote_user [$time_local] "$request" ' + '$status $body_bytes_sent "$http_referer" ' + '"$http_user_agent" "$http_x_forwarded_for"'; + + access_log /var/log/nginx/access.log main; + + sendfile on; + #tcp_nopush on; + + keepalive_timeout 65; + + #gzip on; + + include /etc/nginx/conf.d/*.conf; +} diff --git a/conf/pep/pep.js b/conf/pep/pep.js new file mode 100644 index 0000000..f698b4c --- /dev/null +++ b/conf/pep/pep.js @@ -0,0 +1,322 @@ +export default { enforce }; + +import defaultExport from './config.js'; + +function log(c, s){ + c.request.error(s) +} + +function enforce(r) { + + var context = { + request: r , + config : defaultExport["config"], + backend : (defaultExport.backend ? defaultExport.backend : "@backend") + } + + log(context, "Inside NJS enforce for " + r.method + " @ " + r.headersIn.host + "/" + r.uri) + + context = computeProtection(context) + + wkf.run(wkf.build(context), context) +} + +// ######## WORKFLOW FUNCTIONS ############### +var wkf = { + + build : (context)=>{ + var actions = [ + "export_pep_credentials", + "parse_authentication", + "check_authentication", + "export_authn_token", + "pip", + "pdp", + "export_backend_headers", + "pass" + ] + return actions + }, + + run : (actions, context) => { + context.request.error("Starting workflow with " + njs.dump(actions)) + var w = actions.reduce( + (acc, f) => { return acc.then(typeof(f) === "function" ? f : wkf[f]) }, + Promise.resolve().then(()=>context) + ) + w.catch(e => { context.request.error(njs.dump(e)); context.request.return(401)} ) + }, + + export_pep_credentials : exportPepCredentials, + export_authn_token : exportAuthToken, + export_backend_headers : exportBackendHeaders, + parse_authentication : parseAuthentication, + check_authentication : checkAuthentication, + verify_token : verifyToken, + request_token : requestToken, + pip : pipExecutor, + pdp : pdpExecutor, + pass : pass, + + //PIP utilities + "get-path-component" : (c, i) => c.request.uri.split("/")[i], + "get-token-field" : getTokenField, + "get-contexts" : (c) => { + var ra = c.authn.verified_token["resource_access"] + if(ra){ + var out = []; + for(var k in ra){ + if(ra[k].roles && ra[k].roles.length !== 0) out.push(k) + } + } + return out; + } +} + +function getTokenField(context, f){ + return context.authn.verified_token[f] +} + +function exportVariable(context, name, value){ + context.request.variables[name] = value + log(context, "Exported variables:" + njs.dump(context.request.variables)) + return context +} + +function exportBackendHeaders(context){ + exportVariable(context, "user", context.authn.verified_token.preferred_username) + exportVariable(context, "user_display", context.authn.verified_token.name) + return context +} + +function exportPepCredentials(context){ + if(!context.config["pep-credentials"]){ + throw new Error("Need PEP credentials") + } + return exportVariable(context, "pep_credentials", "Basic " + context.config["pep-credentials"]) +} + +function exportAuthToken(context){ + return exportVariable(context, "auth_token", context.authn.token) +} + +function checkAuthentication(context){ + return context.authn.type === "bearer" ? wkf.verify_token(context) : wkf.request_token(context) +} + +function parseAuthentication(context){ + context.request.log("Inside parseAuthentication") + var incomingauth = context.request.headersIn["Authorization"] + + if(!incomingauth) throw new Error("Authentication required"); + + var arr = incomingauth.trim().replace(/\s\s+/g, " ").split(" ") + if(arr.length != 2) throw new Error("Unknown authentication scheme"); + + var type = arr[0].toLowerCase() + if(type === "basic" && context.authz.host && context.authz.host["allow-basic-auth"]){ + var unamepass = Buffer.from(arr[1], 'base64').toString().split(":") + if(unamepass.length != 2) return null; + context.authn = { type : type, raw : arr[1], user : unamepass[0], password : unamepass[1]} + return context + }else if(type === "bearer"){ + context.authn = { type : type, raw : arr[1], token : arr[1]} + return context + } + throw new Error("Unknown authentication scheme"); +} + +function verifyToken(context){ + log(context, "Inside verifyToken") + var options = { + "body" : "token=" + context.authn.token + "&token_type_hint=access_token" + } + return context.request.subrequest("/jwt_verify_request", options) + .then(reply=>{ + if (reply.status === 200) { + var response = JSON.parse(reply.responseBody); + if (response.active === true) { + return response + } else { + throw new Error("Unauthorized: " + reply.responseBody) + } + } else { + throw new Error("Unauthorized: " + reply.responseBody) + } + }).then(verified_token => { + context.authn.verified_token = + JSON.parse(Buffer.from(context.authn.token.split('.')[1], 'base64url').toString()) + return context + }) +} + +function requestToken(context){ + log(context, "Inside requestToken") + var options = { + "body" : "grant_type=password&username="+context.authn.user+"&password="+context.authn.password + } + return context.request.subrequest("/jwt_request", options) + .then(reply=>{ + if (reply.status === 200) { + var response = JSON.parse(reply.responseBody); + context.authn.token = response.access_token + context.authn.verified_token = + JSON.parse(Buffer.from(context.authn.token.split('.')[1], 'base64url').toString()) + return context + } else if (reply.status === 400 || reply.status === 401){ + var options = { + "body" : "grant_type=password&username="+context.authn.user+"&password="+context.authn.password + } + return context.request.subrequest("/jwt_request", options) + .then( reply=>{ + if (reply.status === 200) { + var response = JSON.parse(reply.responseBody); + context.authn.token = response.access_token + context.authn.verified_token = + JSON.parse(Buffer.from(context.authn.token.split('.')[1], 'base64url').toString()) + return context + } else{ + throw new Error("Unauthorized " + reply.status) + } + }) + } else { + throw new Error("Unauthorized " + reply.status) + } + }) +} + +function pipExecutor(context){ + log(context, "Inside extra claims PIP") + context.authz.pip.forEach(extra =>{ + //call extra claim pip function + try{ + var operator = extra.operator + var result = wkf[operator](context, extra.args) + //ensure array and add to extra_claims + if(!(result instanceof Array)) result = [result] + if(!context.extra_claims) context.extra_claims = {}; + context.extra_claims[extra.claim] = result + } catch (error){ + log(context, "Skipping invalid extra claim " + njs.dump(error)) + } + }) + log(context, "Extra claims are " + njs.dump(context.extra_claims)) + return context +} + +function pdpExecutor(context){ + log(context, "Inside PDP") + return context.authz.pdp(context) +} + +function umaCall(context){ + log(context, "Inside UMA call") + var options = { "body" : computePermissionRequestBody(context) }; + return context.request.subrequest("/permission_request", options) + .then(reply =>{ + if(reply.status === 200){ + return context + }else{ + throw new Error("Response for authorization request is not ok " + reply.status + " " + njs.dump(reply.responseBody)) + } + }) +} + +function pass(context){ + log(context, "Inside pass"); + if(typeof(context.backend) === "string") context.request.internalRedirect(context.backend); + else if (typeof(context.backend) === "function") context.request.internalRedirect(context.backend(context)) + return context; +} + +// ######## AUTHORIZATION PART ############### +function computePermissionRequestBody(context){ + + if(!context.authz.host || !context.authz.path ){ + throw new Error("Enforcemnt mode is always enforcing. Host or path not found...") + } + + var audience = computeAudience(context) + var grant = "grant_type=urn:ietf:params:oauth:grant-type:uma-ticket" + var mode = "response_mode=decision" + var permissions = computePermissions(context) + var extra = "" + if(context.extra_claims){ + extra = + "claim_token_format=urn:ietf:params:oauth:token-type:jwt&claim_token=" + + JSON.stringify(context.extra_claims).toString("base64url") + } + var body = audience + "&" + grant + "&" + permissions + "&" + mode + "&" + extra + context.request.error("Computed permission request body is " + body) + return body +} + +function computeAudience(context){ + var aud = context.request.headersIn.host + if(context.authz.host){ + aud = context.authz.host.audience||context.authz.host.host + } + return "audience=" + aud +} + +function computePermissions(context){ + var resource = context.request.uri + if(context.authz.path){ + resource = context.authz.path.name||context.authz.path.path + } + var scopes = [] + if(context.authz.method && context.authz.method.scopes){ + scopes = context.authz.method.scopes + } + if(scopes.length > 0){ + return scopes.map(s=>"permission=" + resource + "#" + s).join("&") + } + return "permission=" + resource +} + +function getPath(hostconfig, incomingpath, incomingmethod){ + var paths = hostconfig.paths || [] + var matchingpaths = paths + .filter(p => {return incomingpath.match(p.path) != null}) + .reduce((acc, p) => { + if (!p.methods || p.methods.length === 0) acc.weak.push({ path: p}); + else{ + var matchingmethods = p.methods.filter(m=>m.method.toUpperCase() === incomingmethod) + if(matchingmethods.length > 0) acc.strong.push({ method : matchingmethods[0], path: p}); + } + return acc; + }, { strong: [], weak: []}) + return matchingpaths.strong.concat(matchingpaths.weak)[0] +} + +function getHost(config, host){ + var matching = config.hosts.filter(h=>{ + return h.host === host + }) + return matching.length > 0 ? matching[0] : null +} + +function computeProtection(context){ + log(context, "Getting by host " + context.request.headersIn.host) + context.authz = {} + context.authz.host = getHost(context.config, context.request.headersIn.host) + if(context.authz.host !== null){ + log(context, "Host found:" + context.authz.host) + context.authz.pip = context.authz.host.pip ? context.authz.host.pip : []; + context.authz.pdp = context.authz.host.pdp ? context.authz.host.pdp : umaCall; + var pathandmethod = getPath(context.authz.host, context.request.uri, context.request.method); + if(pathandmethod){ + context.authz.path = pathandmethod.path; + context.authz.pip = context.authz.path.pip ? context.authz.pip.concat(context.authz.path.pip) : context.authz.pip; + context.authz.pdp = context.authz.path.pdp ? context.authz.path.pdp : context.authz.pdp; + context.authz.method = pathandmethod.method; + if(context.authz.method){ + context.authz.pip = context.authz.method.pip ? context.authz.pip.concat(context.authz.method.pip) : context.authz.pip; + context.authz.pdp = context.authz.method.pdp ? context.authz.method.pdp : context.authz.pdp; + } + } + } + log(context, "Leaving protection computation: ") + return context +} + diff --git a/images/Dockerfile-cdn b/images/Dockerfile-cdn new file mode 100644 index 0000000..fbfe36d --- /dev/null +++ b/images/Dockerfile-cdn @@ -0,0 +1,12 @@ +### 1. Get muscle classic +FROM nubisware/muscle-classic:latest + +# 2. Install applicative fibers +ADD .muscle/ /root/.muscle/ +RUN git fiber install -p G3 -n d4s-cdn +RUN git fiber install -p G3 -n d4s-navigation -n d4s-vre-manager +RUN git service create -n cdn -w auth -w utils -w config -w error -w utils -w inspect -w resources -w d4s-cdn -w d4s-navigation -w d4s-vre-manager +WORKDIR cdn +VOLUME conf +EXPOSE 8984 +ENTRYPOINT ./start.sh