├── ABAP_Trial └── .empty ├── .dockerignore ├── .gitignore ├── runcontainer ├── createimage ├── patches ├── usr │ └── local │ │ └── bin │ │ ├── runsapinstance │ │ ├── installabaptrial │ │ ├── install.expect │ │ ├── sap_enable_sicf_service │ │ └── sap_add_trusted_server_cert └── etc │ └── pki │ └── ca-trust │ └── source │ └── SAP │ ├── DefaultTrust_DigiCertHighAssuranceEVRootCA.cer │ └── DigiCertSHA2ExtendedValidationServerCA.cer ├── Dockerfile ├── README.md └── LICENSE /ABAP_Trial/.empty: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | ABAP_Trial 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ABAP_Trial 2 | patches.tgz -------------------------------------------------------------------------------- /runcontainer: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker run -d --stop-timeout 1200 --dns-search abap.local -p 3200:3200 -p 3300:3300 -p 8000:8000 -p 44300:44300 --name abaptrial --hostname vhcalnplci asabaptrial catatonit /usr/local/bin/runsapinstance 3 | -------------------------------------------------------------------------------- /createimage: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | start_docker() { 3 | docker run -it --dns-search abap.local -v $PWD/ABAP_Trial:/var/tmp/ABAP_Trial \ 4 | --name abaptmp --hostname vhcalnplci asabaptrial_tmp catatonit /usr/local/bin/installabaptrial 5 | } 6 | docker build -t asabaptrial_tmp . 7 | 8 | if start_docker; then 9 | echo Installation successful, creating final image 10 | docker stop abaptmp 11 | docker commit abaptmp asabaptrial 12 | else 13 | echo Installation failed 14 | fi 15 | docker rm abaptmp 16 | docker image rm asabaptrial_tmp 17 | -------------------------------------------------------------------------------- /patches/usr/local/bin/runsapinstance: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | _term(){ 3 | echo stopping instance 4 | echo 5 | su npladm -c stopsap 6 | echo "instance stopped, killing wating process $child" 7 | kill -9 "$child" 2>/dev/null 8 | } 9 | fixhost(){ 10 | if grep -q '^[^#]*vhcalnplci\.abap.local' /etc/hosts;then 11 | echo no need to patch /etc/hosts 12 | else 13 | sed 's/\(vhcalnplci\)/\1.abap.local \1/' /etc/hosts >~/hosts 14 | cat ~/hosts >/etc/hosts 15 | rm ~/hosts 16 | echo patched /etc/hosts 17 | fi 18 | 19 | if grep -q '^domain\s*abap.local' /etc/resolv.conf;then 20 | echo no need to patch /etc/resolv.conf 21 | else 22 | echo 'domain abap.local' >>/etc/resolv.conf 23 | echo patched /etc/resolv.conf 24 | fi 25 | } 26 | trap _term SIGTERM 27 | 28 | fixhost 29 | uuidd 30 | su npladm -c startsap 31 | tail -f /dev/null & 32 | child=$! 33 | echo "Instance started. waiting on PID $child" 34 | wait "$child" 35 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM opensuse/leap:latest 2 | LABEL hostname="vhalnplci" 3 | 4 | RUN mkdir -p etc/pki/ca-trust/source/SAP 5 | COPY patches/usr/local/bin/* /usr/local/bin/ 6 | COPY patches/etc/pki/ca-trust/source/SAP/* /etc/pki/ca-trust/source/SAP/ 7 | 8 | RUN zypper --non-interactive install --replacefiles \ 9 | uuid uuidd hostname wget expect tcsh tar which net-tools iproute2 gzip libaio1 vim iputils catatonit \ 10 | curl python-openssl python-pip && \ 11 | mkdir /var/run/uuidd && \ 12 | chown uuidd /var/run/uuidd 13 | 14 | # COPY patches.tgz /root/ 15 | # RUN cd /;tar xzf /root/patches.tgz;rm /root/patches.tgz 16 | 17 | # Install PyRFC and run installation 18 | RUN pip install --upgrade pip && \ 19 | cd /var/tmp &&\ 20 | curl -LO https://github.com/SAP/PyRFC/releases/download/1.9.99/pyrfc-1.9.99-cp27-cp27mu-linux_x86_64.whl&& \ 21 | pip install /var/tmp/pyrfc-1.9.99-cp27-cp27mu-linux_x86_64.whl && \ 22 | rm -f /var/tmp/pyrfc-1.9.99-cp27-cp27mu-linux_x86_64.whl 23 | 24 | EXPOSE 8000 25 | EXPOSE 44300 26 | EXPOSE 3300 27 | EXPOSE 3200 28 | -------------------------------------------------------------------------------- /patches/usr/local/bin/installabaptrial: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | fixhost() { 3 | if grep -q '^[^#]*vhcalnplci\.abap.local' /etc/hosts; then 4 | echo no need to patch /etc/hosts 5 | else 6 | sed 's/\(vhcalnplci\)/\1.abap.local \1/' /etc/hosts >~/hosts 7 | cat ~/hosts >/etc/hosts 8 | rm ~/hosts 9 | echo patched /etc/hosts 10 | fi 11 | 12 | if grep -q '^domain\s*abap.local' /etc/resolv.conf; then 13 | echo no need to patch /etc/resolv.conf 14 | else 15 | echo 'domain abap.local' >>/etc/resolv.conf 16 | echo patched /etc/resolv.conf 17 | fi 18 | } 19 | 20 | installcertificates() { 21 | ( 22 | export LD_LIBRARY_PATH=/sapmnt/NPL/exe/uc/linuxx86_64 23 | python /usr/local/bin/sap_add_trusted_server_cert -v /etc/pki/ca-trust/source/SAP/*.cer >/dev/null 2>&1 24 | ) 25 | } 26 | 27 | fixhost 28 | uuidd 29 | /usr/local/bin/install.expect --password "S3cr3tP@ssw0rd" --accept-SAP-developer-license 30 | su npladm -c 'sapcontrol -nr 0 -function GetSystemInstanceList>/dev/null' 31 | retcode=$? 32 | if [ $retcode -eq 0 ]; then 33 | for i in 1 2 3 4 5; do 34 | echo "Installing certificates, attempt $i" 35 | if installcertificates; then 36 | echo "Installation successful" 37 | break 38 | else 39 | if [ $i -lt 5 ]; then 40 | echo "Failed, retrying in 10 seconds" 41 | sleep 10 42 | else 43 | echo "failed permanently" 44 | fi 45 | fi 46 | done 47 | fi 48 | su npladm -c stopsap 49 | exit $retcode 50 | -------------------------------------------------------------------------------- /patches/etc/pki/ca-trust/source/SAP/DefaultTrust_DigiCertHighAssuranceEVRootCA.cer: -------------------------------------------------------------------------------- 1 | -----BEGIN CERTIFICATE----- 2 | MIIDxTCCAq2gAwIBAgIQAqxcJmoLQJuPC3nyrkYldzANBgkqhkiG9w0BAQUFADBs 3 | MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 4 | d3cuZGlnaWNlcnQuY29tMSswKQYDVQQDEyJEaWdpQ2VydCBIaWdoIEFzc3VyYW5j 5 | ZSBFViBSb290IENBMB4XDTA2MTExMDAwMDAwMFoXDTMxMTExMDAwMDAwMFowbDEL 6 | MAkGA1UEBhMCVVMxFTATBgNVBAoTDERpZ2lDZXJ0IEluYzEZMBcGA1UECxMQd3d3 7 | LmRpZ2ljZXJ0LmNvbTErMCkGA1UEAxMiRGlnaUNlcnQgSGlnaCBBc3N1cmFuY2Ug 8 | RVYgUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMbM5XPm 9 | +9S75S0tMqbf5YE/yc0lSbZxKsPVlDRnogocsF9ppkCxxLeyj9CYpKlBWTrT3JTW 10 | PNt0OKRKzE0lgvdKpVMSOO7zSW1xkX5jtqumX8OkhPhPYlG++MXs2ziS4wblCJEM 11 | xChBVfvLWokVfnHoNb9Ncgk9vjo4UFt3MRuNs8ckRZqnrG0AFFoEt7oT61EKmEFB 12 | Ik5lYYeBQVCmeVyJ3hlKV9Uu5l0cUyx+mM0aBhakaHPQNAQTXKFx01p8VdteZOE3 13 | hzBWBOURtCmAEvF5OYiiAhF8J2a3iLd48soKqDirCmTCv2ZdlYTBoSUeh10aUAsg 14 | EsxBu24LUTi4S8sCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgGGMA8GA1UdEwEB/wQF 15 | MAMBAf8wHQYDVR0OBBYEFLE+w2kD+L9HAdSYJhoIAu9jZCvDMB8GA1UdIwQYMBaA 16 | FLE+w2kD+L9HAdSYJhoIAu9jZCvDMA0GCSqGSIb3DQEBBQUAA4IBAQAcGgaX3Nec 17 | nzyIZgYIVyHbIUf4KmeqvxgydkAQV8GK83rZEWWONfqe/EW1ntlMMUu4kehDLI6z 18 | eM7b41N5cdblIZQB2lWHmiRk9opmzN6cN82oNLFpmyPInngiK3BD41VHMWEZ71jF 19 | hS9OMPagMRYjyOfiZRYzy78aG6A9+MpeizGLYAiJLQwGXFK3xPkKmNEVX58Svnw2 20 | Yzi9RKR/5CYrCsSXaQ3pjOLAEFe4yHYSkVXySGnYvCoCWw9E1CAx2/S6cCZdkGCe 21 | vEsXCS+0yx5DaMkHJ8HSXPfqIbloEpw8nL+e/IBcm2PN7EeqJSdnoDfzAIJ9VNep 22 | +OkuE6N36B9K 23 | -----END CERTIFICATE----- 24 | -------------------------------------------------------------------------------- /patches/etc/pki/ca-trust/source/SAP/DigiCertSHA2ExtendedValidationServerCA.cer: -------------------------------------------------------------------------------- 1 | -----BEGIN CERTIFICATE----- 2 | MIIEtjCCA56gAwIBAgIQDHmpRLCMEZUgkmFf4msdgzANBgkqhkiG9w0BAQsFADBs 3 | MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 4 | d3cuZGlnaWNlcnQuY29tMSswKQYDVQQDEyJEaWdpQ2VydCBIaWdoIEFzc3VyYW5j 5 | ZSBFViBSb290IENBMB4XDTEzMTAyMjEyMDAwMFoXDTI4MTAyMjEyMDAwMFowdTEL 6 | MAkGA1UEBhMCVVMxFTATBgNVBAoTDERpZ2lDZXJ0IEluYzEZMBcGA1UECxMQd3d3 7 | LmRpZ2ljZXJ0LmNvbTE0MDIGA1UEAxMrRGlnaUNlcnQgU0hBMiBFeHRlbmRlZCBW 8 | YWxpZGF0aW9uIFNlcnZlciBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC 9 | ggEBANdTpARR+JmmFkhLZyeqk0nQOe0MsLAAh/FnKIaFjI5j2ryxQDji0/XspQUY 10 | uD0+xZkXMuwYjPrxDKZkIYXLBxA0sFKIKx9om9KxjxKws9LniB8f7zh3VFNfgHk/ 11 | LhqqqB5LKw2rt2O5Nbd9FLxZS99RStKh4gzikIKHaq7q12TWmFXo/a8aUGxUvBHy 12 | /Urynbt/DvTVvo4WiRJV2MBxNO723C3sxIclho3YIeSwTQyJ3DkmF93215SF2AQh 13 | cJ1vb/9cuhnhRctWVyh+HA1BV6q3uCe7seT6Ku8hI3UarS2bhjWMnHe1c63YlC3k 14 | 8wyd7sFOYn4XwHGeLN7x+RAoGTMCAwEAAaOCAUkwggFFMBIGA1UdEwEB/wQIMAYB 15 | Af8CAQAwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEF 16 | BQcDAjA0BggrBgEFBQcBAQQoMCYwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRp 17 | Z2ljZXJ0LmNvbTBLBgNVHR8ERDBCMECgPqA8hjpodHRwOi8vY3JsNC5kaWdpY2Vy 18 | dC5jb20vRGlnaUNlcnRIaWdoQXNzdXJhbmNlRVZSb290Q0EuY3JsMD0GA1UdIAQ2 19 | MDQwMgYEVR0gADAqMCgGCCsGAQUFBwIBFhxodHRwczovL3d3dy5kaWdpY2VydC5j 20 | b20vQ1BTMB0GA1UdDgQWBBQ901Cl1qCt7vNKYApl0yHU+PjWDzAfBgNVHSMEGDAW 21 | gBSxPsNpA/i/RwHUmCYaCALvY2QrwzANBgkqhkiG9w0BAQsFAAOCAQEAnbbQkIbh 22 | hgLtxaDwNBx0wY12zIYKqPBKikLWP8ipTa18CK3mtlC4ohpNiAexKSHc59rGPCHg 23 | 4xFJcKx6HQGkyhE6V6t9VypAdP3THYUYUN9XR3WhfVUgLkc3UHKMf4Ib0mKPLQNa 24 | 2sPIoc4sUqIAY+tzunHISScjl2SFnjgOrWNoPLpSgVh5oywM395t6zHyuqB8bPEs 25 | 1OG9d4Q3A84ytciagRpKkk47RpqF/oOi+Z6Mo8wNXrM9zwR4jxQUezKcxwCmXMS1 26 | oVWNWlZopCJwqjyBcdmdqEU79OX2olHdx3ti6G8MdOu42vi/hw15UJGQmxg7kVkn 27 | 8TUoE6smftX3eg== 28 | -----END CERTIFICATE----- 29 | -------------------------------------------------------------------------------- /patches/usr/local/bin/install.expect: -------------------------------------------------------------------------------- 1 | #!/usr/bin/expect -- 2 | # Author: Jakub Filak 3 | # 4 | # This script should make automation of ABAP Trial installation simple. 5 | # The script was designed for installations in Docker and expects 6 | # the installation sources in the directory /var/tmp/ABAP_Trial 7 | 8 | 9 | set optPassword --password 10 | set optAcceptLicense --accept-SAP-developer-license 11 | 12 | proc usage_and_exit {status} { 13 | global optPassword 14 | global optAcceptLicense 15 | 16 | puts "Usage: $::argv0 \[-h|--help\] $optPassword PASSWORD $optAcceptLicense" 17 | exit $status 18 | } 19 | 20 | if {$argc == 0} { 21 | usage_and_exit 1 22 | } 23 | 24 | set password "" 25 | set accepted "no" 26 | 27 | set i 0 28 | while {$i < $argc} { 29 | set opt_arg [lindex $argv $i] 30 | switch -- $opt_arg \ 31 | $optPassword { 32 | incr i 33 | if {$i >= $argc} { 34 | puts stderr "Missing value of the option --password" 35 | usage_and_exit 3 36 | } 37 | 38 | set password [lindex $argv $i] 39 | } \ 40 | $optAcceptLicense { 41 | set accepted "yes" 42 | } \ 43 | -h - \ 44 | --help { 45 | usage_and_exit 0 46 | } \ 47 | default { 48 | puts "Illegal option: $opt_arg" 49 | usage_and_exit 2 50 | } 51 | 52 | incr i 53 | } 54 | 55 | if {$accepted == "no"} { 56 | puts stderr "License was not accepted" 57 | usage_and_exit 4 58 | } 59 | 60 | if {$password == ""} { 61 | puts stderr "Password was not provided" 62 | usage_and_exit 5 63 | } 64 | 65 | set timeout 5 66 | spawn bash /var/tmp/ABAP_Trial/install.sh 67 | 68 | set status 10 69 | expect { 70 | "Do you agree to the above license terms? yes/no:" { 71 | send "yes\n" 72 | } 73 | 74 | timeout { exit [expr $status + 1] } 75 | eof { exit [expr $status + 2] } 76 | } 77 | 78 | set status 20 79 | expect { 80 | "Please enter a password:" { 81 | send "$password\n" 82 | } 83 | 84 | timeout { exit [expr $status + 1] } 85 | eof { exit [expr $status + 2] } 86 | } 87 | 88 | set status 30 89 | expect { 90 | "Please re-enter password for verification:" { 91 | send "$password\n" 92 | } 93 | 94 | timeout { exit [expr $status + 1] } 95 | eof { exit [expr $status + 2] } 96 | } 97 | 98 | set status 40 99 | expect { 100 | "extracting data archives..." { } 101 | 102 | timeout { exit [expr $status + 1] } 103 | eof { exit [expr $status + 2] } 104 | } 105 | 106 | set timeout 7200 107 | 108 | set status 50 109 | expect { 110 | timeout { exit [expr $status + 1] } 111 | eof { exit 0 } 112 | } 113 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SAP netweaver docker image scripts 2 | 3 | These scripts create a SAP NetWeaver ABAP Developer Edition Docker image, and allow you to run it in a container 4 | 5 | A docker image is a blueprint for a container, which is a self contained application. It looks like a dedicated virtual machine but it's not, and uses much less resources compared to a VM like this excellent [Vagrant script by 6 | Alexander Tsybulsky](https://github.com/sbcgua/sap-nw-abap-vagrant) 7 | 8 | Tested on linux (arch). Once an image is created should be possible to run it in 9 | 10 | This is heavily based on [Jakub Filak's Dockerfile](https://github.com/filak-sap/sap-nw-abap-docker), which didn't work out of the box on my arch box 11 | 12 | ## Requirements 13 | 14 | For the installation: 15 | 16 | - a linux machine or VM for the build process, with Docker installed 17 | - enough map areas 18 | SAP needs 1000000, where the default is 65365. This must be set on the system, either by running 19 | 20 | ```bash 21 | sudo sysctl -w vm.max_map_count=1000000 22 | ``` 23 | 24 | or, better, by adding setting vm.max_map_count=1000000 to your config file (depends on your linux distribution I use /etc/sysctl.d/99-sysctl.conf on arch linux, could also create a new file only dor that , say /etc/sysctl.d/98-abap.conf ) 25 | 26 | - lots of disk space. Once installed it should take around 80 Gb (46 for the image, a bit less for the container) but during the build it can require more than 100 27 | - a decent amount of free RAM, say 4 gb 28 | 29 | For running the container: 30 | 31 | - a Docker system (linux is probably best, but should work on ) 32 | - enough map areas (see above) 33 | - some spare RAM. Not sure how much, I guess between 2 and 4 Gb. When idle this uses about 2.5 Gb, but I expect this to increase when you run stuff 34 | 35 | ## Installation 36 | 37 | - Download the installation files 38 | - Go to the [SAP trials download page](https://developers.sap.com/trials-downloads.html) 39 | - search for "7.52 SP04" 40 | - accept the licence and download the 11 rar archives 41 | - extract them in folder ABAP_Trial 42 | - run script createimage (this will take several minutes): 43 | 44 | ```bash 45 | sudo ./createimage 46 | ``` 47 | 48 | - if everything works fine, you will end up with a docker image **abapdevedition** 49 | - start a container again this will take a while to start as it will copy the whole database from the image 50 | 51 | ```bash 52 | sudo ./runcontainer 53 | ``` 54 | 55 | Yor new container will be called abaptrial, and will map the required ports to your local system ports. From here you can continue as any other [AS ABAP installation](https://blogs.sap.com/2017/09/04/newbies-guide-installing-abap-as-751-sp02-on-linux) from point E 56 | 57 | ## Usage 58 | 59 | To connect to your new SAP instance 60 | 61 | - SAPGui: open saplogon and create a new server connection with: 62 | - Application server: your docker server IP address 63 | - System number 00 64 | - SID NPL 65 | - Eclipse: use the connection defined in saplogon 66 | - Visual studio code: Create a connection like this in your configuration file: 67 | 68 | ```JSON 69 | "abapfs.remote": { 70 | "NPL": { 71 | "url": "https://myserverIP:44300", 72 | "username": "developer", 73 | "password": "", 74 | "client": "001", 75 | "allowSelfSigned": true 76 | } 77 | } 78 | ``` 79 | 80 | ## Management 81 | 82 | - start the instance 83 | 84 | ```bash 85 | sudo docker start abaptrial 86 | ``` 87 | 88 | - stop the instance (will try to do it nicely by stopping the server, and then kill it after 20 minutes) 89 | 90 | ```bash 91 | sudo docker stop abaptrial 92 | ``` 93 | 94 | - delete the container (warning, **all the data will be lost**) 95 | 96 | ```bash 97 | sudo docker rm abaptrial 98 | ``` 99 | 100 | - check the start/stop logs (as they are generated) 101 | 102 | ```bash 103 | sudo docker logs -f abaptrial 104 | ``` 105 | 106 | Press Ctrl+C to stop watching them 107 | 108 | ## Technical details 109 | 110 | This works by creating a temporary image, then running a container to install AS ABAP and save the final image 111 | 112 | This is not idedeal, we would want a Dockerfile to do all the work in one stage, but mixes poorly with SAP installation process: 113 | 114 | - Docker sets a dynamic hostname at start 115 | - The installer wants a stable hostname and domain 116 | 117 | Jakub Filak handles this with a custom library that allows mocking the hostname. I do it by setting the hostname and domainat installation/container start patching the configuration files at startup 118 | 119 | This allows to put the installation files in a volume which speeds up the installation process (the total time is probably longer for this one, but it usually fails faster) and should end up in a slimmer image without the installation files 120 | As the whole process is scripted, I don't think this si a big deal 121 | 122 | Also, I start the process using [catatonit](https://github.com/openSUSE/catatonit), which allows to run an unprivileged container 123 | -------------------------------------------------------------------------------- /patches/usr/local/bin/sap_enable_sicf_service: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | Enables SICF HTTP services 4 | """ 5 | 6 | import copy 7 | import base64 8 | import logging 9 | from argparse import ArgumentParser 10 | 11 | from pyrfc import Connection 12 | 13 | 14 | class SICFError(Exception): 15 | """Base exception for errors of this tool""" 16 | 17 | pass 18 | 19 | 20 | # pylint: disable=too-few-public-methods 21 | class SecretValue(object): 22 | """Pseudo secure store for values that should not be stored in memory in 23 | their plain form. 24 | It is not secure at all, it just prevents accidental displaying of 25 | secret values in stack traces in print outs by keeping the value in 26 | non-plain bytes. 27 | """ 28 | 29 | def __init__(self, value): 30 | self._value = base64.b64encode(value[::-1]) 31 | 32 | def decode(self): 33 | """Returns secret value in plain format""" 34 | 35 | return base64.b64decode(self._value)[::-1] 36 | 37 | 38 | # pylint: disable=too-few-public-methods 39 | class ConnectionDetails(object): 40 | """SAP Connection details""" 41 | 42 | # pylint: disable=too-many-arguments 43 | def __init__(self, ashost, sysnr, client, user, passwd, sid=None): 44 | """Initialize the crate for SAP connection details. 45 | 46 | user - an instance of SecretValue 47 | passwd - an instance of SecretValue 48 | """ 49 | 50 | self._params = { 51 | 'ashost': ashost, 52 | 'sysnr': sysnr, 53 | 'client': client, 54 | } 55 | 56 | if sid is not None: 57 | self._params['sid'] = sid 58 | 59 | self._user = user 60 | self._passwd = passwd 61 | 62 | def __eq__(self, other): 63 | return ( 64 | self._params == other._params and 65 | self._user._value == other._user._value and 66 | self._passwd._value == other._passwd._value) 67 | 68 | def __repr__(self): 69 | return '{user} in {sidorhost}/{client}'.format( 70 | sidorhost=self._params.get('sid', self._params['ashost']), 71 | user=self._user.decode(), 72 | **self._params) 73 | 74 | def __str__(self): 75 | return repr(self) 76 | 77 | def to_params(self): 78 | """Dictionary with keys that correspond to parameter names of 79 | pyrfc.Connection constructor 80 | """ 81 | 82 | params = copy.deepcopy(self._params) 83 | params['user'] = self._user.decode() 84 | params['passwd'] = self._passwd.decode() 85 | 86 | return params 87 | 88 | 89 | def _do_rfc_call(conn, function, parameters): 90 | """Simple wrapper to be able to print useful information 91 | for all RFC calls. 92 | """ 93 | 94 | logging.debug('RFC BEGIN: %s <- %s', function, parameters) 95 | response = conn.call(function, **parameters) 96 | logging.debug('RFC END : %s -> %s', function, response) 97 | return response 98 | 99 | 100 | def enable_sicf_services(conn_spec, urls): 101 | """Enables SICF HTTP Service 102 | """ 103 | 104 | with Connection(**conn_spec.to_params()) as conn: 105 | logging.info('Successfully connected: %s', repr(conn_spec)) 106 | 107 | for url in urls: 108 | logging.debug('Enabling: %s', url) 109 | _do_rfc_call(conn, 'HTTP_ACTIVATE_NODE', {'URL': url}) 110 | 111 | 112 | def _main(argv): 113 | arg_parser = ArgumentParser( 114 | description='Enable HTTP endpoints') 115 | arg_parser.add_argument( 116 | '--ashost', dest='ashost', type=str, default='localhost', 117 | help='Application Server address (DNS or IP)') 118 | arg_parser.add_argument( 119 | '--sid', dest='sid', type=str, default='NPL', 120 | help='System ID (SID)') 121 | arg_parser.add_argument( 122 | '--client', dest='client', type=str, default='001', 123 | help='Client (MANDT)') 124 | arg_parser.add_argument( 125 | '--sysnr', dest='sysnr', type=str, default='00', 126 | help='System Number') 127 | arg_parser.add_argument( 128 | '--user', dest='user', type=str, default='DEVELOPER', 129 | help='Logon user') 130 | arg_parser.add_argument( 131 | '--passwd', dest='passwd', type=str, default='Down1oad', 132 | help='Logon user') 133 | arg_parser.add_argument( 134 | '-v', '--verbose', dest='verbose', action='count', default=0, 135 | help='Logon user') 136 | arg_parser.add_argument( 137 | 'urls', metavar='URLS', type=str, nargs='+', 138 | help='SICF Services URLs') 139 | 140 | args = arg_parser.parse_args(argv) 141 | 142 | log_level = logging.ERROR - args.verbose * 10 143 | logging.getLogger().setLevel(log_level if log_level >= 0 else 0) 144 | 145 | conn_spec = ConnectionDetails( 146 | ashost=args.ashost, sysnr=args.sysnr, sid=args.sid, client=args.client, 147 | user=SecretValue(args.user), passwd=SecretValue(args.passwd)) 148 | 149 | enable_sicf_services(conn_spec, args.urls) 150 | 151 | 152 | if __name__ == '__main__': 153 | import sys 154 | 155 | _main(sys.argv[1:]) 156 | -------------------------------------------------------------------------------- /patches/usr/local/bin/sap_add_trusted_server_cert: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | Uploads X.509 Base64 certificates into SAP to enable SSL peer verification 4 | of remote servers 5 | """ 6 | 7 | import copy 8 | import base64 9 | import logging 10 | from argparse import ArgumentParser 11 | 12 | from pyrfc import Connection 13 | 14 | 15 | class UploadCertError(Exception): 16 | """Base exception for errors of this tool""" 17 | 18 | pass 19 | 20 | 21 | class InvalidSSLStorage(UploadCertError): 22 | """Invalid SSL storage errors""" 23 | 24 | pass 25 | 26 | 27 | class PutCertificateError(UploadCertError): 28 | """Adding Certificate errors""" 29 | 30 | pass 31 | 32 | 33 | # pylint: disable=too-few-public-methods 34 | class SecretValue(object): 35 | """Pseudo secure store for values that should not be stored in memory in 36 | their plain form. 37 | It is not secure at all, it just prevents accidental displaying of 38 | secret values in stack traces in print outs by keeping the value in 39 | non-plain bytes. 40 | """ 41 | 42 | def __init__(self, value): 43 | self._value = base64.b64encode(value[::-1]) 44 | 45 | def decode(self): 46 | """Returns secret value in plain format""" 47 | 48 | return base64.b64decode(self._value)[::-1] 49 | 50 | 51 | # pylint: disable=too-few-public-methods 52 | class ConnectionDetails(object): 53 | """SAP Connection details""" 54 | 55 | # pylint: disable=too-many-arguments 56 | def __init__(self, ashost, sysnr, client, user, passwd, sid=None): 57 | """Initialize the crate for SAP connection details. 58 | 59 | user - an instance of SecretValue 60 | passwd - an instance of SecretValue 61 | """ 62 | 63 | self._params = { 64 | 'ashost': ashost, 65 | 'sysnr': sysnr, 66 | 'client': client, 67 | } 68 | 69 | if sid is not None: 70 | self._params['sid'] = sid 71 | 72 | self._user = user 73 | self._passwd = passwd 74 | 75 | def __eq__(self, other): 76 | return ( 77 | self._params == other._params and 78 | self._user._value == other._user._value and 79 | self._passwd._value == other._passwd._value) 80 | 81 | def __repr__(self): 82 | return '{user} in {sidorhost}/{client}'.format( 83 | sidorhost=self._params.get('sid', self._params['ashost']), 84 | user=self._user.decode(), 85 | **self._params) 86 | 87 | def __str__(self): 88 | return repr(self) 89 | 90 | def to_params(self): 91 | """Dictionary with keys that correspond to parameter names of 92 | pyrfc.Connection constructor 93 | """ 94 | 95 | params = copy.deepcopy(self._params) 96 | params['user'] = self._user.decode() 97 | params['passwd'] = self._passwd.decode() 98 | 99 | return params 100 | 101 | 102 | def _do_rfc_call(conn, function, parameters): 103 | """Simple wrapper to be able to print useful information 104 | for all RFC calls. 105 | """ 106 | 107 | logging.debug('RFC BEGIN: %s <- %s', function, parameters) 108 | response = conn.call(function, **parameters) 109 | logging.debug('RFC END : %s -> %s', function, response) 110 | return response 111 | 112 | 113 | class SSLCertStorage(object): 114 | """SAP STRUST representation""" 115 | 116 | def __init__(self, conn, pse_context, pse_applic): 117 | self._conn = conn 118 | self.identity = { 119 | 'PSE_CONTEXT': pse_context, 120 | 'PSE_APPLIC': pse_applic 121 | } 122 | 123 | @staticmethod 124 | def client_anonymous_storage(conn): 125 | """Client Anonymous Storage""" 126 | 127 | return SSLCertStorage(conn, u'SSLC', u'ANONYM') 128 | 129 | def __repr__(self): 130 | return 'SSL Storage {PSE_CONTEXT}/{PSE_APPLIC}'.format(**self.identity) 131 | 132 | def __str__(self): 133 | return repr(self) 134 | 135 | def raise_if_not_ok(self): 136 | """Checks if the storage is OK and if not, raise an exception 137 | of the type InvalidSSLStorage. 138 | """ 139 | 140 | stat = _do_rfc_call( 141 | self._conn, 142 | 'SSFR_PSE_CHECK', 143 | {'IS_STRUST_IDENTITY': self.identity}) 144 | 145 | ret = stat['ET_BAPIRET2'] 146 | if not ret or ret[0].get('TYPE', '') != 'S': 147 | raise InvalidSSLStorage( 148 | 'The {0} is broken: {1}'.format(str(self), ret[0]['MESSAGE'])) 149 | 150 | def put_certificate(self, cert): 151 | """Adds the passed certificate to the storage""" 152 | 153 | stat = _do_rfc_call( 154 | self._conn, 155 | 'SSFR_PUT_CERTIFICATE', 156 | {'IS_STRUST_IDENTITY': self.identity, 'IV_CERTIFICATE': cert}) 157 | 158 | ret = stat['ET_BAPIRET2'] 159 | if ret: 160 | raise PutCertificateError( 161 | 'Failed to put the CERT to the {0}: {1}'.format( 162 | str(self), 163 | ret[0]['MESSAGE'])) 164 | 165 | 166 | def add_trusted_server_certs(conn_spec, paths): 167 | """Makes certificates in the selected files trusted by 168 | an application server. 169 | """ 170 | 171 | with Connection(**conn_spec.to_params()) as conn: 172 | logging.info('Successfully connected: %s', repr(conn_spec)) 173 | 174 | ssl_storage = SSLCertStorage.client_anonymous_storage(conn) 175 | ssl_storage.raise_if_not_ok() 176 | logging.debug('SSL Storage is OK: %s', repr(ssl_storage)) 177 | 178 | for file_path in paths: 179 | logging.info('Adding the file: %s', file_path) 180 | 181 | with open(file_path) as cert_file: 182 | cert_contents = cert_file.read() 183 | ssl_storage.put_certificate(cert_contents) 184 | 185 | 186 | def _main(argv): 187 | arg_parser = ArgumentParser( 188 | description='Makes X.509 Base64 certificates trusted an SAP AS') 189 | arg_parser.add_argument( 190 | '--ashost', dest='ashost', type=str, default='localhost', 191 | help='Application Server address (DNS or IP)') 192 | arg_parser.add_argument( 193 | '--sid', dest='sid', type=str, default='NPL', 194 | help='System ID (SID)') 195 | arg_parser.add_argument( 196 | '--client', dest='client', type=str, default='001', 197 | help='Client (MANDT)') 198 | arg_parser.add_argument( 199 | '--sysnr', dest='sysnr', type=str, default='00', 200 | help='System Number') 201 | arg_parser.add_argument( 202 | '--user', dest='user', type=str, default='DEVELOPER', 203 | help='Logon user') 204 | arg_parser.add_argument( 205 | '--passwd', dest='passwd', type=str, default='Down1oad', 206 | help='Logon user') 207 | arg_parser.add_argument( 208 | '-v', '--verbose', dest='verbose', action='count', default=0, 209 | help='Logon user') 210 | arg_parser.add_argument( 211 | 'paths', metavar='CERT', type=str, nargs='+', 212 | help='a file path containing X.509 Base64 certificate') 213 | 214 | args = arg_parser.parse_args(argv) 215 | 216 | log_level = logging.ERROR - args.verbose * 10 217 | logging.getLogger().setLevel(log_level if log_level >= 0 else 0) 218 | 219 | conn_spec = ConnectionDetails( 220 | ashost=args.ashost, sysnr=args.sysnr, sid=args.sid, client=args.client, 221 | user=SecretValue(args.user), passwd=SecretValue(args.passwd)) 222 | 223 | add_trusted_server_certs(conn_spec, args.paths) 224 | 225 | 226 | if __name__ == '__main__': 227 | import sys 228 | 229 | _main(sys.argv[1:]) 230 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------