├── pfSenseBackup ├── pfSenseBackup.csproj ├── Exceptions.cs ├── Utils.cs ├── Program.cs └── Classes │ └── pfSense.cs ├── Dockerfile ├── pfSenseBackup.sln ├── .gitlab-ci.yml ├── README.md ├── .gitignore └── LICENSE /pfSenseBackup/pfSenseBackup.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp2.0 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM microsoft/dotnet:2.0-sdk as builder 2 | 3 | RUN mkdir /app 4 | WORKDIR /app 5 | 6 | COPY pfSenseBackup/ . 7 | RUN dotnet clean 8 | RUN dotnet restore 9 | RUN dotnet publish -c Release -o out 10 | 11 | # Actual deployment image 12 | FROM microsoft/dotnet:2.0-runtime 13 | RUN mkdir /app 14 | WORKDIR /app 15 | COPY --from=builder /app/out/ /app/ 16 | ENTRYPOINT ["dotnet", "pfSenseBackup.dll"] -------------------------------------------------------------------------------- /pfSenseBackup/Exceptions.cs: -------------------------------------------------------------------------------- 1 | 2 | using System; 3 | using System.Collections.Generic; 4 | using System.Text; 5 | 6 | namespace pfSenseBackup 7 | { 8 | public class UsernamePasswordInvalidException : Exception 9 | { 10 | public UsernamePasswordInvalidException(string message) 11 | : base(message) 12 | { 13 | } 14 | 15 | public UsernamePasswordInvalidException(string message, Exception inner) 16 | : base(message, inner) 17 | { 18 | } 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /pfSenseBackup/Utils.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Text; 4 | 5 | namespace pfSenseBackup 6 | { 7 | public static class Utils 8 | { 9 | public static string ToSafeFileName(this string s) 10 | { 11 | return s 12 | .Replace("\\", "") 13 | .Replace("/", "") 14 | .Replace("\"", "") 15 | .Replace("*", "") 16 | .Replace(":", "") 17 | .Replace("?", "") 18 | .Replace("<", "") 19 | .Replace(">", "") 20 | .Replace("|", ""); 21 | } 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /pfSenseBackup/Program.cs: -------------------------------------------------------------------------------- 1 | using pfSenseBackup.Classes; 2 | using System; 3 | 4 | namespace pfSenseBackup 5 | { 6 | class Program 7 | { 8 | static void Main(string[] args) 9 | { 10 | if (args.Length != 3) 11 | { 12 | Console.WriteLine($"Please run this application with three arguments: the URL of your pfSense machine, your username and password E.g. https://mypfsense:8443 admin password"); 13 | Environment.Exit(1); 14 | } 15 | 16 | Run(args[0], args[1], args[2]); 17 | } 18 | 19 | static void Run(string url, string username, string password) 20 | { 21 | PfSense pfSense = new PfSense(url, username, password); 22 | pfSense.DownloadBackup(); 23 | 24 | #if DEBUG 25 | Console.ReadKey(); 26 | #endif 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /pfSenseBackup.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.27703.2000 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "pfSenseBackup", "pfSenseBackup\pfSenseBackup.csproj", "{87EB8041-1024-43C5-8C26-C61CFEB770FF}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {87EB8041-1024-43C5-8C26-C61CFEB770FF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {87EB8041-1024-43C5-8C26-C61CFEB770FF}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {87EB8041-1024-43C5-8C26-C61CFEB770FF}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {87EB8041-1024-43C5-8C26-C61CFEB770FF}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {6AEF3B45-5530-4FFC-A001-BBBF99570FB4} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | stages: 2 | - develop 3 | - release 4 | 5 | services: 6 | - docker:dind 7 | 8 | develop: 9 | stage: develop 10 | image: docker:latest 11 | script: 12 | - docker build -f Dockerfile -t $CI_REGISTRY_IMAGE:develop . 13 | 14 | - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY 15 | - docker push $CI_REGISTRY_IMAGE:develop 16 | 17 | - echo "---------------------------------------" 18 | - echo "Cleanup" 19 | - echo "---------------------------------------" 20 | - docker rmi $CI_REGISTRY_IMAGE:develop 21 | only: 22 | - develop 23 | 24 | release: 25 | stage: release 26 | image: docker:latest 27 | script: 28 | - docker build -f Dockerfile -t $CI_REGISTRY_IMAGE:$CI_BUILD_TAG . 29 | - docker tag $CI_REGISTRY_IMAGE:$CI_BUILD_TAG $CI_REGISTRY_IMAGE:latest 30 | 31 | - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY 32 | - docker push $CI_REGISTRY_IMAGE:$CI_BUILD_TAG 33 | - docker push $CI_REGISTRY_IMAGE:latest 34 | 35 | - echo "---------------------------------------" 36 | - echo "Cleanup" 37 | - echo "---------------------------------------" 38 | - docker rmi $CI_REGISTRY_IMAGE:$CI_BUILD_TAG 39 | - docker rmi $CI_REGISTRY_IMAGE:latest 40 | only: 41 | - tags 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pfSense backup (pfSense 2.3.3 and higher) 2 | ## What does this tool do? 3 | This tool has been created for users who want to download pfSense configuration backups with ease and store the configuration files themselves. 4 | 5 | It's based on [https://doc.pfsense.org/index.php/Remote_Config_Backup](https://doc.pfsense.org/index.php/Remote_Config_Backup). 6 | 7 | Big note: if you want to support pfSense, you might want to get a [gold subscription](https://portal.pfsense.org/members/signup/gold) which supports both the project and you'll get access to the [AutoConfigBackup](https://doc.pfsense.org/index.php/AutoConfigBackup) tool. 8 | 9 | ## How do I run this? 10 | ### Easy way: 11 | `docker run --rm -v /my/backup/folder:/app/backups gerwim/pfsense-backup https://192.168.0.1:8443 admin password` 12 | 13 | This will store the backup in `/my/backup/folder`. Just add the command above in a cronjob, task scheduler or something else to create backups on a recurring base. 14 | 15 | ### Compile it yourself way: 16 | 1) Clone this git repository (and `cd` into it) 17 | 2) Run `docker build -t pfsense-backup .` 18 | 3) Run (basically) the same command as above: `docker run --rm -v /my/backup/folder:/app/backups pfsense-backup https://192.168.0.1:8443 admin password` 19 | 20 | ## Automatically backup multiple pfSense machines 21 | 1) Create the backup folders (`mkdir -p /opt/pfSense/backups/pfSense-{master,slave,another}`) 22 | 2) Create a new script: `vi autoBackup.sh` with the contents below (modify where needed!) 23 | ``` 24 | #!/bin/bash 25 | 26 | BackupTarget() { 27 | docker run --rm -v $1:/app/backups gerwim/pfsense-backup $2 $3 $4 >> /opt/pfSense/output.log 28 | } 29 | 30 | # Backup master 31 | BackupTarget "/opt/pfSense/backups/pfSense-master" "https://10.10.10.2:444" "admin" "password" 32 | 33 | # Backup slave 34 | BackupTarget "/opt/pfSense/backups/pfSense-slave" "https://10.10.10.3:444" "admin" "password" 35 | 36 | # Backup another pfSense 37 | BackupTarget "/opt/pfSense/backups/pfSense-another" "https://10.10.10.4:444" "admin" "password" 38 | ``` 39 | 40 | 3) Finally make the script executable `chmod +x autoBackup.sh` and run it: `./autoBackup.sh`. You can run this file by cron to backup your pfSense systems automatically. 41 | -------------------------------------------------------------------------------- /pfSenseBackup/Classes/pfSense.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Linq; 4 | using System.Net; 5 | using System.Text; 6 | 7 | namespace pfSenseBackup.Classes 8 | { 9 | public class PfSense 10 | { 11 | readonly string username; 12 | readonly string password; 13 | readonly string url; 14 | 15 | CookieContainer cookieContainer = new CookieContainer(); 16 | string csrfToken; 17 | 18 | public PfSense(string url, string username, string password) 19 | { 20 | this.username = username; 21 | this.password = password; 22 | this.url = url; 23 | } 24 | 25 | public bool DownloadBackup() 26 | { 27 | try 28 | { 29 | if (Stage1() && Stage2() && Stage3()) 30 | { 31 | Console.WriteLine($"{DateTime.Now} [SUCCESS] Downloaded a backup copy!"); 32 | return true; 33 | } 34 | 35 | return false; 36 | } 37 | catch (Exception ex) 38 | { 39 | Console.WriteLine($"{DateTime.Now} [FATAL] Could not download config: {ex.Message}"); 40 | return false; 41 | } 42 | 43 | } 44 | 45 | private bool Stage1() 46 | { 47 | HttpWebRequest request = (HttpWebRequest)WebRequest.Create($"{url}/diag_backup.php"); 48 | request.CookieContainer = cookieContainer; 49 | request.ServerCertificateValidationCallback += (sender, certificate, chain, sslPolicyErrors) => true; 50 | 51 | HttpWebResponse response = (HttpWebResponse)request.GetResponse(); 52 | string html; 53 | using (StreamReader reader = new StreamReader(response.GetResponseStream())) 54 | { 55 | html = reader.ReadToEnd(); 56 | } 57 | 58 | ExtractCSRFToken(html); 59 | 60 | return true; 61 | } 62 | 63 | private bool Stage2() 64 | { 65 | HttpWebRequest request = (HttpWebRequest)WebRequest.Create($"{url}/diag_backup.php"); 66 | request.CookieContainer = cookieContainer; 67 | request.ServerCertificateValidationCallback += (sender, certificate, chain, sslPolicyErrors) => true; 68 | request.Method = "POST"; 69 | 70 | var postData = "login=Login"; 71 | postData += $"&usernamefld={username}"; 72 | postData += $"&passwordfld={password}"; 73 | postData += $"&__csrf_magic={csrfToken}"; 74 | var data = Encoding.ASCII.GetBytes(postData); 75 | 76 | request.ContentType = "application/x-www-form-urlencoded"; 77 | request.ContentLength = data.Length; 78 | 79 | using (var stream = request.GetRequestStream()) 80 | { 81 | stream.Write(data, 0, data.Length); 82 | } 83 | 84 | HttpWebResponse response = (HttpWebResponse)request.GetResponse(); 85 | string html; 86 | using (StreamReader reader = new StreamReader(response.GetResponseStream())) 87 | { 88 | html = reader.ReadToEnd(); 89 | } 90 | 91 | // pfSense does not throw a 403 or some sort, so we need to check the contents if it contains username/password invalid string 92 | if (html.Contains("Username or Password incorrect")) 93 | throw new UsernamePasswordInvalidException("Username or Password incorrect"); 94 | 95 | ExtractCSRFToken(html); 96 | 97 | return true; 98 | } 99 | 100 | private bool Stage3() 101 | { 102 | HttpWebRequest request = (HttpWebRequest)WebRequest.Create($"{url}/diag_backup.php"); 103 | request.CookieContainer = cookieContainer; 104 | request.ServerCertificateValidationCallback += (sender, certificate, chain, sslPolicyErrors) => true; 105 | request.Method = "POST"; 106 | 107 | var postData = "download=download"; 108 | postData += "&donotbackuprrd=yes"; 109 | postData += $"&__csrf_magic={csrfToken}"; 110 | var data = Encoding.ASCII.GetBytes(postData); 111 | 112 | request.ContentType = "application/x-www-form-urlencoded"; 113 | request.ContentLength = data.Length; 114 | 115 | using (var stream = request.GetRequestStream()) 116 | { 117 | stream.Write(data, 0, data.Length); 118 | } 119 | 120 | HttpWebResponse response = (HttpWebResponse)request.GetResponse(); 121 | using (StreamReader reader = new StreamReader(response.GetResponseStream())) 122 | { 123 | // Create file 124 | string fileName = $"pfSenseBackup-{DateTime.Now}.xml"; 125 | Directory.CreateDirectory("backups"); // create directory if it does not exist 126 | using (FileStream fs = File.Create(Path.Combine("backups", fileName.ToSafeFileName()))) 127 | { 128 | Byte[] info = new UTF8Encoding(true).GetBytes(reader.ReadToEnd()); 129 | // Add some information to the file. 130 | fs.Write(info, 0, info.Length); 131 | } 132 | } 133 | return true; 134 | } 135 | 136 | private void ExtractCSRFToken(string html) 137 | { 138 | // Parse html, extract the CSRF token 139 | var htmlDocument = new HtmlAgilityPack.HtmlDocument(); 140 | htmlDocument.LoadHtml(html); 141 | 142 | csrfToken = htmlDocument.DocumentNode.Descendants("input") 143 | .FirstOrDefault(x => x.Attributes["name"].Value == "__csrf_magic") 144 | .Attributes["value"].Value; 145 | } 146 | 147 | } 148 | } 149 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.suo 8 | *.user 9 | *.userosscache 10 | *.sln.docstates 11 | 12 | # User-specific files (MonoDevelop/Xamarin Studio) 13 | *.userprefs 14 | 15 | # Build results 16 | [Dd]ebug/ 17 | [Dd]ebugPublic/ 18 | [Rr]elease/ 19 | [Rr]eleases/ 20 | x64/ 21 | x86/ 22 | bld/ 23 | [Bb]in/ 24 | [Oo]bj/ 25 | [Ll]og/ 26 | 27 | # Visual Studio 2015/2017 cache/options directory 28 | .vs/ 29 | # Uncomment if you have tasks that create the project's static files in wwwroot 30 | #wwwroot/ 31 | 32 | # Visual Studio 2017 auto generated files 33 | Generated\ Files/ 34 | 35 | # MSTest test Results 36 | [Tt]est[Rr]esult*/ 37 | [Bb]uild[Ll]og.* 38 | 39 | # NUNIT 40 | *.VisualState.xml 41 | TestResult.xml 42 | 43 | # Build Results of an ATL Project 44 | [Dd]ebugPS/ 45 | [Rr]eleasePS/ 46 | dlldata.c 47 | 48 | # Benchmark Results 49 | BenchmarkDotNet.Artifacts/ 50 | 51 | # .NET Core 52 | project.lock.json 53 | project.fragment.lock.json 54 | artifacts/ 55 | **/Properties/launchSettings.json 56 | 57 | # StyleCop 58 | StyleCopReport.xml 59 | 60 | # Files built by Visual Studio 61 | *_i.c 62 | *_p.c 63 | *_i.h 64 | *.ilk 65 | *.meta 66 | *.obj 67 | *.iobj 68 | *.pch 69 | *.pdb 70 | *.ipdb 71 | *.pgc 72 | *.pgd 73 | *.rsp 74 | *.sbr 75 | *.tlb 76 | *.tli 77 | *.tlh 78 | *.tmp 79 | *.tmp_proj 80 | *.log 81 | *.vspscc 82 | *.vssscc 83 | .builds 84 | *.pidb 85 | *.svclog 86 | *.scc 87 | 88 | # Chutzpah Test files 89 | _Chutzpah* 90 | 91 | # Visual C++ cache files 92 | ipch/ 93 | *.aps 94 | *.ncb 95 | *.opendb 96 | *.opensdf 97 | *.sdf 98 | *.cachefile 99 | *.VC.db 100 | *.VC.VC.opendb 101 | 102 | # Visual Studio profiler 103 | *.psess 104 | *.vsp 105 | *.vspx 106 | *.sap 107 | 108 | # Visual Studio Trace Files 109 | *.e2e 110 | 111 | # TFS 2012 Local Workspace 112 | $tf/ 113 | 114 | # Guidance Automation Toolkit 115 | *.gpState 116 | 117 | # ReSharper is a .NET coding add-in 118 | _ReSharper*/ 119 | *.[Rr]e[Ss]harper 120 | *.DotSettings.user 121 | 122 | # JustCode is a .NET coding add-in 123 | .JustCode 124 | 125 | # TeamCity is a build add-in 126 | _TeamCity* 127 | 128 | # DotCover is a Code Coverage Tool 129 | *.dotCover 130 | 131 | # AxoCover is a Code Coverage Tool 132 | .axoCover/* 133 | !.axoCover/settings.json 134 | 135 | # Visual Studio code coverage results 136 | *.coverage 137 | *.coveragexml 138 | 139 | # NCrunch 140 | _NCrunch_* 141 | .*crunch*.local.xml 142 | nCrunchTemp_* 143 | 144 | # MightyMoose 145 | *.mm.* 146 | AutoTest.Net/ 147 | 148 | # Web workbench (sass) 149 | .sass-cache/ 150 | 151 | # Installshield output folder 152 | [Ee]xpress/ 153 | 154 | # DocProject is a documentation generator add-in 155 | DocProject/buildhelp/ 156 | DocProject/Help/*.HxT 157 | DocProject/Help/*.HxC 158 | DocProject/Help/*.hhc 159 | DocProject/Help/*.hhk 160 | DocProject/Help/*.hhp 161 | DocProject/Help/Html2 162 | DocProject/Help/html 163 | 164 | # Click-Once directory 165 | publish/ 166 | 167 | # Publish Web Output 168 | *.[Pp]ublish.xml 169 | *.azurePubxml 170 | # Note: Comment the next line if you want to checkin your web deploy settings, 171 | # but database connection strings (with potential passwords) will be unencrypted 172 | *.pubxml 173 | *.publishproj 174 | 175 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 176 | # checkin your Azure Web App publish settings, but sensitive information contained 177 | # in these scripts will be unencrypted 178 | PublishScripts/ 179 | 180 | # NuGet Packages 181 | *.nupkg 182 | # The packages folder can be ignored because of Package Restore 183 | **/[Pp]ackages/* 184 | # except build/, which is used as an MSBuild target. 185 | !**/[Pp]ackages/build/ 186 | # Uncomment if necessary however generally it will be regenerated when needed 187 | #!**/[Pp]ackages/repositories.config 188 | # NuGet v3's project.json files produces more ignorable files 189 | *.nuget.props 190 | *.nuget.targets 191 | 192 | # Microsoft Azure Build Output 193 | csx/ 194 | *.build.csdef 195 | 196 | # Microsoft Azure Emulator 197 | ecf/ 198 | rcf/ 199 | 200 | # Windows Store app package directories and files 201 | AppPackages/ 202 | BundleArtifacts/ 203 | Package.StoreAssociation.xml 204 | _pkginfo.txt 205 | *.appx 206 | 207 | # Visual Studio cache files 208 | # files ending in .cache can be ignored 209 | *.[Cc]ache 210 | # but keep track of directories ending in .cache 211 | !*.[Cc]ache/ 212 | 213 | # Others 214 | ClientBin/ 215 | ~$* 216 | *~ 217 | *.dbmdl 218 | *.dbproj.schemaview 219 | *.jfm 220 | *.pfx 221 | *.publishsettings 222 | orleans.codegen.cs 223 | 224 | # Including strong name files can present a security risk 225 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 226 | #*.snk 227 | 228 | # Since there are multiple workflows, uncomment next line to ignore bower_components 229 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 230 | #bower_components/ 231 | 232 | # RIA/Silverlight projects 233 | Generated_Code/ 234 | 235 | # Backup & report files from converting an old project file 236 | # to a newer Visual Studio version. Backup files are not needed, 237 | # because we have git ;-) 238 | _UpgradeReport_Files/ 239 | Backup*/ 240 | UpgradeLog*.XML 241 | UpgradeLog*.htm 242 | ServiceFabricBackup/ 243 | *.rptproj.bak 244 | 245 | # SQL Server files 246 | *.mdf 247 | *.ldf 248 | *.ndf 249 | 250 | # Business Intelligence projects 251 | *.rdl.data 252 | *.bim.layout 253 | *.bim_*.settings 254 | *.rptproj.rsuser 255 | 256 | # Microsoft Fakes 257 | FakesAssemblies/ 258 | 259 | # GhostDoc plugin setting file 260 | *.GhostDoc.xml 261 | 262 | # Node.js Tools for Visual Studio 263 | .ntvs_analysis.dat 264 | node_modules/ 265 | 266 | # Visual Studio 6 build log 267 | *.plg 268 | 269 | # Visual Studio 6 workspace options file 270 | *.opt 271 | 272 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 273 | *.vbw 274 | 275 | # Visual Studio LightSwitch build output 276 | **/*.HTMLClient/GeneratedArtifacts 277 | **/*.DesktopClient/GeneratedArtifacts 278 | **/*.DesktopClient/ModelManifest.xml 279 | **/*.Server/GeneratedArtifacts 280 | **/*.Server/ModelManifest.xml 281 | _Pvt_Extensions 282 | 283 | # Paket dependency manager 284 | .paket/paket.exe 285 | paket-files/ 286 | 287 | # FAKE - F# Make 288 | .fake/ 289 | 290 | # JetBrains Rider 291 | .idea/ 292 | *.sln.iml 293 | 294 | # CodeRush 295 | .cr/ 296 | 297 | # Python Tools for Visual Studio (PTVS) 298 | __pycache__/ 299 | *.pyc 300 | 301 | # Cake - Uncomment if you are using it 302 | # tools/** 303 | # !tools/packages.config 304 | 305 | # Tabs Studio 306 | *.tss 307 | 308 | # Telerik's JustMock configuration file 309 | *.jmconfig 310 | 311 | # BizTalk build output 312 | *.btp.cs 313 | *.btm.cs 314 | *.odx.cs 315 | *.xsd.cs 316 | 317 | # OpenCover UI analysis results 318 | OpenCover/ 319 | 320 | # Azure Stream Analytics local run output 321 | ASALocalRun/ 322 | 323 | # MSBuild Binary and Structured Log 324 | *.binlog 325 | 326 | # NVidia Nsight GPU debugger configuration file 327 | *.nvuser 328 | 329 | # MFractors (Xamarin productivity tool) working folder 330 | .mfractor/ 331 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2018 os 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------