├── Models ├── PasswordChangeRequest.cs ├── UserCreateRequest.cs └── DocumentRequest.cs ├── appsettings.Development.json ├── appsettings.json ├── GlobalUsings.cs ├── Dockerfile ├── Kosync.csproj ├── Database ├── Entities │ ├── User.cs │ └── Document.cs └── KosyncDb.cs ├── Utility.cs ├── Program.cs ├── Properties └── launchSettings.json ├── .vscode ├── tasks.json └── launch.json ├── .github └── workflows │ └── docker-publish.yml ├── Services ├── UserService.cs ├── ProxyService.cs └── IPService.cs ├── README.md ├── Controllers ├── SyncController.cs └── ManagementController.cs ├── .gitignore └── LICENSE /Models/PasswordChangeRequest.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Models; 2 | 3 | public class PasswordChangeRequest 4 | { 5 | public string password { get; set; } = default!; 6 | } -------------------------------------------------------------------------------- /appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | }, 8 | "AllowedHosts": "*" 9 | } 10 | -------------------------------------------------------------------------------- /Models/UserCreateRequest.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Models; 2 | 3 | public class UserCreateRequest 4 | { 5 | public string username { get; set; } = default!; 6 | 7 | public string password { get; set; } = default!; 8 | } -------------------------------------------------------------------------------- /GlobalUsings.cs: -------------------------------------------------------------------------------- 1 | global using Kosync.Database; 2 | global using Kosync.Database.Entities; 3 | global using Kosync.Models; 4 | global using Kosync.Services; 5 | global using LiteDB; 6 | global using System; 7 | global using System.Security.Cryptography; 8 | global using System.Text; -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Build environment 2 | FROM mcr.microsoft.com/dotnet/sdk:8.0-alpine AS build-env 3 | WORKDIR /app 4 | COPY . ./ 5 | RUN dotnet restore 6 | RUN dotnet publish -c Release -o output 7 | 8 | # Runtime environment 9 | FROM mcr.microsoft.com/dotnet/aspnet:8.0-alpine 10 | WORKDIR /app 11 | COPY --from=build-env /app/output . 12 | ENTRYPOINT ["dotnet", "Kosync.dll"] -------------------------------------------------------------------------------- /Models/DocumentRequest.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Models; 2 | 3 | public class DocumentRequest 4 | { 5 | public string document { get; set; } = default!; 6 | 7 | public string progress { get; set; } = default!; 8 | 9 | public decimal percentage { get; set; } = default!; 10 | 11 | public string device { get; set; } = default!; 12 | 13 | public string device_id { get; set; } = default!; 14 | } -------------------------------------------------------------------------------- /Kosync.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | net8.0 4 | enable 5 | enable 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /Database/Entities/User.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Database.Entities; 2 | 3 | public class User 4 | { 5 | public int Id { get; set; } 6 | 7 | public string Username { get; set; } = default!; 8 | 9 | public string PasswordHash { get; set; } = default!; 10 | 11 | public bool IsActive { get; set; } = true; 12 | 13 | public bool IsAdministrator { get; set; } = false; 14 | 15 | public List Documents { get; set; } = new(); 16 | } -------------------------------------------------------------------------------- /Database/Entities/Document.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Database.Entities; 2 | 3 | public class Document 4 | { 5 | public string DocumentHash { get; set; } = default!; 6 | 7 | public string Progress { get; set; } = default!; 8 | 9 | public decimal Percentage { get; set; } = default!; 10 | 11 | public string Device { get; set; } = default!; 12 | 13 | public string DeviceId { get; set; } = default!; 14 | 15 | public DateTime Timestamp {get;set;} = default!; 16 | } -------------------------------------------------------------------------------- /Utility.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync; 2 | 3 | public static class Utility 4 | { 5 | public static string HashPassword(string password) 6 | { 7 | var md5 = MD5.Create(); 8 | 9 | md5.ComputeHash(ASCIIEncoding.ASCII.GetBytes(password)); 10 | 11 | var result = md5.Hash!; 12 | 13 | StringBuilder strBuilder = new StringBuilder(); 14 | for (int i = 0; i < result.Length; i++) 15 | { 16 | strBuilder.Append(result[i].ToString("x2")); 17 | } 18 | 19 | return strBuilder.ToString(); 20 | } 21 | } -------------------------------------------------------------------------------- /Program.cs: -------------------------------------------------------------------------------- 1 | using System.Net; 2 | 3 | var builder = WebApplication.CreateBuilder(args); 4 | 5 | builder.Services.AddHttpContextAccessor(); 6 | 7 | 8 | builder.Services.AddSingleton(); 9 | builder.Services.AddScoped(); 10 | builder.Services.AddScoped(); 11 | builder.Services.AddScoped(); 12 | 13 | 14 | builder.Services.AddControllers(); 15 | 16 | 17 | if (Environment.GetEnvironmentVariable("SINGLE_LINE_LOGGING") == "true") 18 | { 19 | 20 | builder.Logging.ClearProviders(); 21 | builder.Logging.AddSimpleConsole(options => 22 | { 23 | options.SingleLine = true; 24 | }); 25 | } 26 | 27 | 28 | var app = builder.Build(); 29 | 30 | app.UseForwardedHeaders(); 31 | 32 | app.MapControllers(); 33 | 34 | 35 | 36 | app.Run(); 37 | -------------------------------------------------------------------------------- /Database/KosyncDb.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Database; 2 | 3 | public class KosyncDb 4 | { 5 | public LiteDatabase Context { get; } = default!; 6 | 7 | public KosyncDb() 8 | { 9 | Context = new LiteDatabase("Filename=data/Kosync.db;Connection=shared"); 10 | CreateDefaults(); 11 | } 12 | 13 | public void CreateDefaults() 14 | { 15 | var adminPassword = Environment.GetEnvironmentVariable("ADMIN_PASSWORD"); 16 | if (adminPassword is null) 17 | { 18 | adminPassword = "admin"; 19 | } 20 | 21 | var userCollection = Context.GetCollection("users"); 22 | 23 | var adminUser = userCollection.FindOne(i => i.Username == "admin"); 24 | if (adminUser is null) 25 | { 26 | adminUser = new User() 27 | { 28 | Username = "admin", 29 | IsAdministrator = true, 30 | }; 31 | userCollection.Insert(adminUser); 32 | } 33 | 34 | adminUser.PasswordHash = Utility.HashPassword(adminPassword); 35 | 36 | userCollection.Update(adminUser); 37 | userCollection.EnsureIndex(i => i.Username); 38 | } 39 | } -------------------------------------------------------------------------------- /Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json.schemastore.org/launchsettings.json", 3 | "iisSettings": { 4 | "windowsAuthentication": false, 5 | "anonymousAuthentication": true, 6 | "iisExpress": { 7 | "applicationUrl": "http://localhost:58055", 8 | "sslPort": 44359 9 | } 10 | }, 11 | "profiles": { 12 | "http": { 13 | "commandName": "Project", 14 | "dotnetRunMessages": true, 15 | "launchBrowser": false, 16 | "applicationUrl": "http://localhost:5181", 17 | "environmentVariables": { 18 | "ASPNETCORE_ENVIRONMENT": "Development" 19 | } 20 | }, 21 | "https": { 22 | "commandName": "Project", 23 | "dotnetRunMessages": true, 24 | "launchBrowser": false, 25 | "applicationUrl": "http://localhost:5181", 26 | "environmentVariables": { 27 | "ASPNETCORE_ENVIRONMENT": "Development" 28 | } 29 | }, 30 | "IIS Express": { 31 | "commandName": "IISExpress", 32 | "launchBrowser": false, 33 | "launchUrl": "swagger", 34 | "environmentVariables": { 35 | "ASPNETCORE_ENVIRONMENT": "Development" 36 | } 37 | } 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "build", 6 | "command": "dotnet", 7 | "type": "process", 8 | "args": [ 9 | "build", 10 | "${workspaceFolder}/Kosync.csproj", 11 | "/property:GenerateFullPaths=true", 12 | "/consoleloggerparameters:NoSummary" 13 | ], 14 | "problemMatcher": "$msCompile" 15 | }, 16 | { 17 | "label": "publish", 18 | "command": "dotnet", 19 | "type": "process", 20 | "args": [ 21 | "publish", 22 | "${workspaceFolder}/Kosync.csproj", 23 | "/property:GenerateFullPaths=true", 24 | "/consoleloggerparameters:NoSummary" 25 | ], 26 | "problemMatcher": "$msCompile" 27 | }, 28 | { 29 | "label": "watch", 30 | "command": "dotnet", 31 | "type": "process", 32 | "args": [ 33 | "watch", 34 | "run", 35 | "--project", 36 | "${workspaceFolder}/Kosync.csproj" 37 | ], 38 | "problemMatcher": "$msCompile" 39 | } 40 | ] 41 | } -------------------------------------------------------------------------------- /.github/workflows/docker-publish.yml: -------------------------------------------------------------------------------- 1 | name: Create and publish a Docker image 2 | 3 | on: 4 | push: 5 | tags: 6 | - 'v*.*.*' 7 | 8 | env: 9 | REGISTRY: ghcr.io 10 | IMAGE_NAME: ${{ github.repository }} 11 | 12 | jobs: 13 | build-and-push-image: 14 | runs-on: ubuntu-latest 15 | permissions: 16 | contents: read 17 | packages: write 18 | 19 | steps: 20 | - name: Checkout repository 21 | uses: actions/checkout@v3 22 | 23 | - name: Log in to the Container registry 24 | uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 25 | with: 26 | registry: ${{ env.REGISTRY }} 27 | username: ${{ github.actor }} 28 | password: ${{ secrets.GITHUB_TOKEN }} 29 | 30 | - name: Extract metadata (tags, labels) for Docker 31 | id: meta 32 | uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 33 | with: 34 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 35 | 36 | - name: Build and push Docker image 37 | uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 38 | with: 39 | context: . 40 | push: true 41 | tags: ${{ steps.meta.outputs.tags }} 42 | labels: ${{ steps.meta.outputs.labels }} -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | // Use IntelliSense to find out which attributes exist for C# debugging 6 | // Use hover for the description of the existing attributes 7 | // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md 8 | "name": ".NET Core Launch (web)", 9 | "type": "coreclr", 10 | "request": "launch", 11 | "preLaunchTask": "build", 12 | // If you have changed target frameworks, make sure to update the program path. 13 | "program": "${workspaceFolder}/bin/Debug/net7.0/Kosync.dll", 14 | "args": [], 15 | "cwd": "${workspaceFolder}", 16 | "stopAtEntry": false, 17 | // Enable launching a web browser when ASP.NET Core starts. For more information: https://aka.ms/VSCode-CS-LaunchJson-WebBrowser 18 | // "serverReadyAction": { 19 | // "action": "openExternally", 20 | // "pattern": "\\bNow listening on:\\s+(https?://\\S+)" 21 | // }, 22 | "env": { 23 | "ASPNETCORE_ENVIRONMENT": "Development" 24 | }, 25 | "sourceFileMap": { 26 | "/Views": "${workspaceFolder}/Views" 27 | } 28 | }, 29 | { 30 | "name": ".NET Core Attach", 31 | "type": "coreclr", 32 | "request": "attach" 33 | } 34 | ] 35 | } -------------------------------------------------------------------------------- /Services/UserService.cs: -------------------------------------------------------------------------------- 1 | namespace Kosync.Services; 2 | 3 | public class UserService 4 | { 5 | private IHttpContextAccessor _contextAccessor; 6 | private KosyncDb _db; 7 | 8 | private bool userLoadAttempted = false; 9 | 10 | 11 | private string? _username = ""; 12 | public string? Username 13 | { 14 | get 15 | { 16 | LoadUser(); 17 | return _username; 18 | } 19 | } 20 | 21 | private bool _isAuthenticated = false; 22 | public bool IsAuthenticated 23 | { 24 | get 25 | { 26 | LoadUser(); 27 | return _isAuthenticated; 28 | } 29 | } 30 | 31 | private bool _isActive = false; 32 | public bool IsActive 33 | { 34 | get 35 | { 36 | LoadUser(); 37 | return _isActive; 38 | } 39 | } 40 | 41 | private bool _isAdmin = false; 42 | public bool IsAdmin 43 | { 44 | get 45 | { 46 | LoadUser(); 47 | return _isAdmin; 48 | } 49 | } 50 | 51 | 52 | public UserService(IHttpContextAccessor contextAccessor, KosyncDb db) 53 | { 54 | _contextAccessor = contextAccessor; 55 | _db = db; 56 | } 57 | 58 | private void LoadUser() 59 | { 60 | if (userLoadAttempted) { return; } 61 | 62 | userLoadAttempted = true; 63 | 64 | _username = _contextAccessor?.HttpContext?.Request.Headers["x-auth-user"]; 65 | 66 | string? passwordHash = _contextAccessor?.HttpContext?.Request.Headers["x-auth-key"]; 67 | 68 | var userCollection = _db.Context.GetCollection("users"); 69 | 70 | var user = userCollection.FindOne(i => i.Username == _username && i.PasswordHash == passwordHash); 71 | 72 | if (user is null) { return; } 73 | 74 | 75 | _isAuthenticated = true; 76 | 77 | _isActive = user.IsActive; 78 | 79 | _isAdmin = user.IsAdministrator; 80 | } 81 | } -------------------------------------------------------------------------------- /Services/ProxyService.cs: -------------------------------------------------------------------------------- 1 | 2 | 3 | using System.Net; 4 | 5 | namespace Kosync.Services; 6 | 7 | public class ProxyService 8 | { 9 | private readonly ILogger? _logger; 10 | 11 | private bool _proxiesLoaded = false; 12 | 13 | 14 | private string[] _trustedProxies = []; 15 | /// 16 | /// List of configured trusted proxies 17 | /// 18 | public string[] TrustedProxies 19 | { 20 | get 21 | { 22 | LoadProxies(); 23 | return _trustedProxies; 24 | } 25 | } 26 | 27 | 28 | public ProxyService(ILogger logger) 29 | { 30 | _logger = logger; 31 | } 32 | 33 | private void LoadProxies() 34 | { 35 | if (_proxiesLoaded) { return; } 36 | 37 | _proxiesLoaded = true; 38 | string? tempString; 39 | 40 | string? proxies = Environment.GetEnvironmentVariable("TRUSTED_PROXIES"); 41 | 42 | if (string.IsNullOrEmpty(proxies)) 43 | { 44 | LogInfo("No trusted proxies set."); 45 | 46 | return; 47 | } 48 | 49 | string[] tempProxies = proxies.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries); 50 | 51 | for (int i = 0; i < tempProxies.Length; i++) 52 | { 53 | if (!IPAddress.TryParse(tempProxies[i], out _)) 54 | { 55 | LogWarning($"Inavalid trusted proxy - {tempProxies[i]}"); 56 | 57 | tempProxies[i] = ""; 58 | } 59 | } 60 | 61 | _trustedProxies = tempProxies.Where(p => !string.IsNullOrEmpty(p)).ToArray(); 62 | 63 | if (_trustedProxies.Length == 0) 64 | { 65 | LogWarning("No valid trusted proxies set."); 66 | } 67 | else 68 | { 69 | tempString = ""; 70 | 71 | foreach (var prox in _trustedProxies) 72 | { 73 | if (!string.IsNullOrEmpty(tempString)) { tempString += ", "; } 74 | 75 | tempString += prox; 76 | } 77 | 78 | tempString = "Trusted proxies: " + tempString; 79 | 80 | LogInfo(tempString); 81 | } 82 | } 83 | 84 | private void LogWarning(string text) 85 | { 86 | Log(LogLevel.Warning, text); 87 | } 88 | 89 | private void LogInfo(string text) 90 | { 91 | Log(LogLevel.Information, text); 92 | } 93 | 94 | private void Log(LogLevel level, string text) 95 | { 96 | text = $"[{DateTime.Now.ToString("yyyy/MM/dd HH:mm:ss")}] {text}"; 97 | _logger?.Log(level, text); 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /Services/IPService.cs: -------------------------------------------------------------------------------- 1 | 2 | 3 | using System.Net; 4 | 5 | namespace Kosync.Services; 6 | 7 | public class IPService 8 | { 9 | private readonly HttpContext? _context; 10 | private readonly ILogger? _logger; 11 | private readonly ProxyService _proxyService; 12 | 13 | private bool _ipLoaded = false; 14 | 15 | 16 | private bool _trustedProxy = false; 17 | /// 18 | /// Is this connection from a trusted proxy 19 | /// 20 | public bool TrustedProxy 21 | { 22 | get 23 | { 24 | LoadIP(); 25 | return _trustedProxy; 26 | } 27 | } 28 | 29 | private string _clientIP = ""; 30 | /// 31 | /// The IP address of the client 32 | /// 33 | public string ClientIP 34 | { 35 | get 36 | { 37 | LoadIP(); 38 | return _clientIP; 39 | } 40 | } 41 | 42 | 43 | public IPService(IHttpContextAccessor accessor, ILogger? logger, ProxyService proxyService) 44 | { 45 | _context = accessor.HttpContext; 46 | _logger = logger; 47 | _proxyService = proxyService; 48 | 49 | LoadIP(); 50 | } 51 | 52 | private void LoadIP() 53 | { 54 | if (_ipLoaded) { return; } 55 | 56 | _ipLoaded = true; 57 | 58 | string? connectingIP; 59 | 60 | IPAddress? remoteIP = _context?.Connection.RemoteIpAddress; 61 | 62 | if (remoteIP is null) 63 | { 64 | connectingIP = ""; 65 | } 66 | else 67 | { 68 | if (remoteIP.IsIPv4MappedToIPv6) 69 | { 70 | remoteIP = remoteIP.MapToIPv4(); 71 | } 72 | 73 | connectingIP = remoteIP.ToString(); 74 | } 75 | 76 | if (connectingIP is null) { connectingIP = ""; } 77 | 78 | //LogInfo("Forwarded - " + _context?.Request.Headers["X-Forwarded-For"]); 79 | //LogInfo("Actual - " + _context?.Connection.RemoteIpAddress.ToString()); 80 | if (_proxyService.TrustedProxies.Contains(connectingIP)) 81 | { 82 | _trustedProxy = true; 83 | 84 | 85 | string? forwardedFor = _context?.Request.Headers["X-Forwarded-For"].FirstOrDefault(); 86 | if (!string.IsNullOrEmpty(forwardedFor)) 87 | { 88 | forwardedFor = forwardedFor.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries).FirstOrDefault(); 89 | } 90 | 91 | if (!string.IsNullOrEmpty(forwardedFor) && 92 | IPAddress.TryParse(forwardedFor, out _)) 93 | { 94 | _clientIP = forwardedFor; 95 | } 96 | } 97 | 98 | if (string.IsNullOrEmpty(_clientIP)) 99 | { 100 | if (_trustedProxy) 101 | { 102 | LogWarning($"Trusted proxy [{connectingIP}] failed to forward client IP address."); 103 | } 104 | 105 | _clientIP = connectingIP; 106 | } 107 | 108 | if (string.IsNullOrEmpty(_clientIP)) 109 | { 110 | LogWarning($"Unable to determine client IP address."); 111 | } 112 | } 113 | 114 | private void LogWarning(string text) 115 | { 116 | Log(LogLevel.Warning, text); 117 | } 118 | 119 | private void LogInfo(string text) 120 | { 121 | Log(LogLevel.Information, text); 122 | } 123 | 124 | private void Log(LogLevel level, string text) 125 | { 126 | text = $"[{DateTime.Now.ToString("yyyy/MM/dd HH:mm:ss")}] {text}"; 127 | _logger?.Log(level, text); 128 | } 129 | } 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # kosync-dotnet 2 | 3 | **kosync-dotnet** is a self-hostable implementation of the KOReader sync server built with .NET. It aims to extend the existing functionality of the official [koreader-sync-server](https://github.com/koreader/koreader-sync-server). 4 | 5 | Users of KOReader can register a user on this synchronisation server and use the inbuilt _Progress sync_ plugin to keep all reading progress synchronised between devices. 6 | 7 | All data is stored inside a [LiteDB](https://www.litedb.org/) database file. 8 | 9 | ## How to run your own server? 10 | 11 | The recommendation is to use [Docker](https://www.docker.com/) with [Docker Compose](https://docs.docker.com/compose/). 12 | 13 | ``` 14 | version: "3" 15 | services: 16 | kosync: 17 | container_name: kosync 18 | image: ghcr.io/jberlyn/kosync-dotnet:latest 19 | restart: unless-stopped 20 | volumes: 21 | - :/app/data 22 | environment: 23 | - ASPNETCORE_HTTP_PORTS=8080 24 | - ADMIN_PASSWORD= 25 | - REGISTRATION_DISABLED=false 26 | - TRUSTED_PROXIES=1.2.3.4, ::1 27 | user: 1000:1000 28 | ``` 29 | 30 | `/app/data` will contain the database, which stores user and document progress information. 31 | 32 | An admin user with the username `admin` will be created when the server first starts. If you provide the `ADMIN_PASSWORD` environment variable, the password for this admin user will be changed to the value provided. If you do not provide a value, the password for this user will be set to `admin`. The recommendation is to set this to a strong password generated with a password manager like [Bitwarden](https://bitwarden.com/). This admin user can be used to interact with the management API. 33 | 34 | If the `REGISTRATION_DISABLED` environment variable is set to `true`, the sync server will respond with an `User registration is disabled` error message when trying to create a new user. This is useful if you expose your sync server to the public internet, but don't want anyone to be able to register a user. This is a feature that is not available in the official sync server. 35 | 36 | The `TRUSTED_PROXIES` environment variable is an optional variable that defines one or more trusted proxies. It should be a comma delineated list of IPv4 or IPv6 addresses. If `TRUSTED_PROXIES` is set, when a request comes through a trusted proxy, the X-Forwarded-For header will be checked for the client's real IP address to use in logging. If `TRUSTED_PROXIES` is not set, or if a request does not come through a trusted proxy, the request's source IP address will be used for logging. Requests that do not come through a trusted proxy when `TRUSTED_PROXIES` is set will be marked with an asterisk (*) in the logs. 37 | 38 | If you would like logging output to be on a single line, you may add the environment variable `SINGLE_LINE_LOGGING` and set it to `true`. 39 | 40 | Mapping user to `1000:1000` is just a way to ensure the database files are created using your own user, rather than root. If your operating system user ID is different from `1000:1000`, change it to yours. 41 | 42 | This example doesn't expose any ports for the container, however the sync server is accessible via port `8080` inside the container. The recommendation is to expose the server via a reverse proxy such as [Nginx Proxy Manager](https://nginxproxymanager.com/). 43 | 44 | Prior to .NET 8, the default port was `80`. This was changed for [various reasons](https://learn.microsoft.com/en-us/dotnet/core/compatibility/containers/8.0/aspnet-port) by Microsoft. You can manually set the port using the `ASPNETCORE_HTTP_PORTS` environment variable, if this is something you would like to configure. 45 | 46 | ## Management API 47 | 48 | There are some management API endpoints you can interact with using a tool like [Postman](https://www.postman.com/). 49 | 50 | Only the admin user can make requests to these API endpoints, with the exception of users being allowed to query and delete their own documents and delete their own account. 51 | 52 | All requests to these API endpoints require the following headers. 53 | 54 | ```json 55 | { 56 | "x-auth-user": "admin" 57 | "x-auth-key": "" 58 | } 59 | ``` 60 | 61 | Since we reuse the existing user structure used for KOReader, unfortunately we are stuck using MD5 hashes for passwords instead of something more secure. 62 | 63 | ### GET /manage/users 64 | 65 | Returns a list of all users. 66 | 67 | **Example Response** 68 | 69 | ```json 70 | [ 71 | { 72 | "id": 1, 73 | "username": "admin", 74 | "isAdministrator": true, 75 | "isActive": true, 76 | "documentCount": 0 77 | }, 78 | { 79 | "id": 1, 80 | "username": "jberlyn", 81 | "isAdministrator": false, 82 | "isActive": true, 83 | "documentCount": 1 84 | } 85 | ] 86 | ``` 87 | 88 | ### POST /manage/users 89 | 90 | Creates a new user. This endpoint circumvents the `REGISTRATION_DISABLED` environment variable. 91 | 92 | **Request Body** 93 | 94 | ```json 95 | { 96 | "username": "jberlyn", 97 | "password": "super-strong-password" 98 | } 99 | ``` 100 | 101 | **Example Response** 102 | 103 | ```json 104 | { 105 | "message": "User created successfully" 106 | } 107 | ``` 108 | 109 | ### DELETE /manage/users?username=username 110 | 111 | Deletes a user. The username to be deleted must be passed via a query parameter. 112 | 113 | **Example Response** 114 | 115 | ```json 116 | { 117 | "message": "Success" 118 | } 119 | ``` 120 | 121 | ### GET /manage/users/documents?username=username 122 | 123 | Returns a list of documents for a user and their sync status. The username for the user must be passed via a query parameter. 124 | 125 | **Example Response** 126 | 127 | ```json 128 | [ 129 | { 130 | "documentHash": "b8a9c5b494e7c91ece4cb8407e746ec7", 131 | "progress": "/body/DocFragment[28]/body/div/section/h1[1]/a/span/text().0", 132 | "percentage": 0.3186, 133 | "device": "Kobo_nova", 134 | "deviceId": "F47D5CA7123A4ABEAB90E8BF6F836356", 135 | "timestamp": "2023-05-23T11:43:00.225+10:00" 136 | }, 137 | { 138 | "documentHash": "b1e5b67d6b0fe57ce9893d08dce65406", 139 | "progress": "/body/DocFragment[10]/body/div/h1/text().0", 140 | "percentage": 0.0166, 141 | "device": "Kobo_nova", 142 | "deviceId": "F47D5CA7123A4ABEAB90E8BF6F836356", 143 | "timestamp": "2023-05-23T11:44:34.165+10:00" 144 | } 145 | ] 146 | ``` 147 | 148 | ### DELETE /manage/users/documents?username=username&documentHash=documentHash 149 | 150 | Deletes a document for a user. The username for the user and the document hash must be passed via query parameters. 151 | 152 | ***Example Response*** 153 | 154 | ```json 155 | { 156 | "message": "Success" 157 | } 158 | ``` 159 | 160 | ### PUT /manage/users/active?username=username 161 | 162 | Toggles the active status of a user. The username for the user must be passed via a query parameter. Users that are marked as inactive will not be able to login or push sync progress. 163 | 164 | **Example Response** 165 | 166 | ```json 167 | { 168 | "message": "User marked as inactive" 169 | } 170 | ``` 171 | 172 | ### PUT /manage/users/password?username=username 173 | 174 | Updates the password for a user. The username for the user must be passed via a query parameter. 175 | 176 | **Request Body** 177 | 178 | ```json 179 | { 180 | "password": "super-strong-password" 181 | } 182 | ``` 183 | 184 | **Example Response** 185 | 186 | ```json 187 | { 188 | "message": "Password changed successfully" 189 | } 190 | ``` -------------------------------------------------------------------------------- /Controllers/SyncController.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | 3 | namespace Kosync.Controllers; 4 | 5 | [ApiController] 6 | public class SyncController : ControllerBase 7 | { 8 | private ILogger _logger; 9 | 10 | private ProxyService _proxyService; 11 | private IPService _ipService; 12 | private KosyncDb _db; 13 | private UserService _userService; 14 | 15 | 16 | public SyncController(ILogger logger, ProxyService proxyService, IPService ipService, KosyncDb db, UserService userService) 17 | { 18 | _logger = logger; 19 | _proxyService = proxyService; 20 | _ipService = ipService; 21 | _db = db; 22 | _userService = userService; 23 | } 24 | 25 | [HttpGet("/")] 26 | public IActionResult Index() 27 | { 28 | return Ok("kosync-dotnet server is running."); 29 | } 30 | 31 | [HttpGet("/healthcheck")] 32 | public ObjectResult HealthCheck() 33 | { 34 | return StatusCode(200, new 35 | { 36 | state = "OK" 37 | }); 38 | } 39 | 40 | [HttpGet("/users/auth")] 41 | public ObjectResult AuthoriseUser() 42 | { 43 | string? username = Request.Headers["x-auth-user"]; 44 | string? passwordHash = Request.Headers["x-auth-key"]; 45 | 46 | if (username is null || passwordHash is null) 47 | { 48 | LogWarning("Request to /users/auth without credentials"); 49 | 50 | return StatusCode(401, new 51 | { 52 | message = "Invalid credentials" 53 | }); 54 | } 55 | 56 | if (!_userService.IsAuthenticated) 57 | { 58 | LogWarning($"Login to [{username}] attempted with invalid credentials."); 59 | 60 | return StatusCode(401, new 61 | { 62 | message = "User could not be found" 63 | }); 64 | } 65 | 66 | if (!_userService.IsActive) 67 | { 68 | LogWarning($"Login to inactive account [{username}] attempted."); 69 | 70 | return StatusCode(401, new 71 | { 72 | message = "User is inactive" 73 | }); 74 | } 75 | 76 | LogInfo($"User [{username}] logged in."); 77 | return StatusCode(200, new 78 | { 79 | username = _userService.Username 80 | }); 81 | } 82 | 83 | [HttpPost("/users/create")] 84 | public ObjectResult CreateUser(UserCreateRequest payload) 85 | { 86 | if (Environment.GetEnvironmentVariable("REGISTRATION_DISABLED") == "true") 87 | { 88 | LogWarning("Account creation attempted but registration is disabled."); 89 | return StatusCode(402, new 90 | { 91 | message = "User registration is disabled" 92 | }); 93 | } 94 | 95 | var userCollection = _db.Context.GetCollection("users"); 96 | 97 | var existing = userCollection.FindOne(u => u.Username == payload.username); 98 | if (existing is not null) 99 | { 100 | LogInfo($"Account creation attempted with existing username - [{payload.username}]."); 101 | return StatusCode(402, new 102 | { 103 | message = "User already exists" 104 | }); 105 | } 106 | 107 | var user = new User() 108 | { 109 | Username = payload.username, 110 | PasswordHash = payload.password, 111 | }; 112 | 113 | userCollection.Insert(user); 114 | userCollection.EnsureIndex(u => u.Username); 115 | 116 | 117 | LogInfo($"User [{payload.username}] created."); 118 | return StatusCode(201, new 119 | { 120 | username = payload.username 121 | }); 122 | } 123 | 124 | [HttpPut("/syncs/progress")] 125 | public ObjectResult SyncProgress(DocumentRequest payload) 126 | { 127 | if (!_userService.IsAuthenticated) 128 | { 129 | if (string.IsNullOrEmpty(_userService.Username)) 130 | { 131 | LogWarning("Unauthenticated progress update received."); 132 | } 133 | else 134 | { 135 | LogWarning($"Unauthenticated progress update for user [{_userService.Username}] received."); 136 | } 137 | 138 | return StatusCode(401, new 139 | { 140 | message = "Unauthorized" 141 | }); 142 | } 143 | 144 | if (!_userService.IsActive) 145 | { 146 | LogWarning($"Progress update from inactive user [{_userService.Username}] received."); 147 | 148 | return StatusCode(401, new 149 | { 150 | message = "Unauthorized" 151 | }); 152 | } 153 | 154 | var userCollection = _db.Context.GetCollection("users").Include(i => i.Documents); 155 | 156 | var user = userCollection.FindOne(i => i.Username == _userService.Username); 157 | 158 | var document = user.Documents.SingleOrDefault(i => i.DocumentHash == payload.document); 159 | if (document is null) 160 | { 161 | document = new Document(); 162 | document.DocumentHash = payload.document; 163 | user.Documents.Add(document); 164 | } 165 | 166 | document.Progress = payload.progress; 167 | document.Percentage = payload.percentage; 168 | document.Device = payload.device; 169 | document.DeviceId = payload.device_id; 170 | document.Timestamp = DateTime.UtcNow; 171 | 172 | userCollection.Update(user); 173 | 174 | LogInfo($"Received progress update for user [{_userService.Username}] from device [{payload.device}] with document hash [{payload.document}]."); 175 | return StatusCode(200, new 176 | { 177 | document = document.DocumentHash, 178 | timestamp = document.Timestamp 179 | }); 180 | } 181 | 182 | [HttpGet("/syncs/progress/{documentHash}")] 183 | public IActionResult GetProgress(string documentHash) 184 | { 185 | if (!_userService.IsAuthenticated) 186 | { 187 | if (string.IsNullOrEmpty(_userService.Username)) 188 | { 189 | LogWarning("Unauthenticated progress request received."); 190 | } 191 | else 192 | { 193 | LogWarning($"Unauthenticated progress request for user [{_userService.Username}] received."); 194 | } 195 | 196 | return StatusCode(401, new 197 | { 198 | message = "Unauthorized" 199 | }); 200 | } 201 | 202 | if (!_userService.IsActive) 203 | { 204 | LogWarning($"Progress request from inactive user [{_userService.Username}] received."); 205 | 206 | return StatusCode(401, new 207 | { 208 | message = "Unauthorized" 209 | }); 210 | } 211 | 212 | var userCollection = _db.Context.GetCollection("users").Include(i => i.Documents); 213 | 214 | var user = userCollection.FindOne(i => i.Username == _userService.Username); 215 | 216 | var document = user.Documents.SingleOrDefault(i => i.DocumentHash == documentHash); 217 | 218 | if (document is null) 219 | { 220 | LogInfo($"Document hash [{documentHash}] not found for user [{_userService.Username}]."); 221 | return StatusCode(502, new 222 | { 223 | message = "Document not found on server" 224 | }); 225 | } 226 | 227 | LogInfo($"Received progress request for user [{_userService.Username}] with document hash [{documentHash}]."); 228 | 229 | var time = new DateTimeOffset(document.Timestamp); 230 | 231 | var result = new 232 | { 233 | device = document.Device, 234 | device_id = document.DeviceId, 235 | document = document.DocumentHash, 236 | percentage = document.Percentage, 237 | progress = document.Progress, 238 | timestamp = time.ToUnixTimeSeconds() 239 | }; 240 | 241 | string json = System.Text.Json.JsonSerializer.Serialize(result); 242 | 243 | return new ContentResult() 244 | { 245 | Content = json, 246 | ContentType = "application/json", 247 | StatusCode = 200 248 | }; 249 | } 250 | 251 | private void LogInfo(string text) 252 | { 253 | Log(LogLevel.Information, text); 254 | } 255 | 256 | private void LogWarning(string text) 257 | { 258 | Log(LogLevel.Warning, text); 259 | } 260 | 261 | private void Log(LogLevel level, string text) 262 | { 263 | string logMsg = $"[{DateTime.Now.ToString("yyyy/MM/dd HH:mm:ss")}] [{_ipService.ClientIP}]"; 264 | 265 | 266 | // If trusted proxies are set but this request comes from another address, mark it 267 | if (_proxyService.TrustedProxies.Length > 0 && 268 | !_ipService.TrustedProxy) 269 | { 270 | logMsg += "*"; 271 | } 272 | 273 | logMsg += $" {text}"; 274 | 275 | _logger?.Log(level, logMsg); 276 | } 277 | } 278 | -------------------------------------------------------------------------------- /.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/main/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Ll]og/ 33 | [Ll]ogs/ 34 | 35 | # Visual Studio 2015/2017 cache/options directory 36 | .vs/ 37 | # Uncomment if you have tasks that create the project's static files in wwwroot 38 | #wwwroot/ 39 | 40 | # Visual Studio 2017 auto generated files 41 | Generated\ Files/ 42 | 43 | # MSTest test Results 44 | [Tt]est[Rr]esult*/ 45 | [Bb]uild[Ll]og.* 46 | 47 | # NUnit 48 | *.VisualState.xml 49 | TestResult.xml 50 | nunit-*.xml 51 | 52 | # Build Results of an ATL Project 53 | [Dd]ebugPS/ 54 | [Rr]eleasePS/ 55 | dlldata.c 56 | 57 | # Benchmark Results 58 | BenchmarkDotNet.Artifacts/ 59 | 60 | # .NET 61 | project.lock.json 62 | project.fragment.lock.json 63 | artifacts/ 64 | 65 | # Tye 66 | .tye/ 67 | 68 | # ASP.NET Scaffolding 69 | ScaffoldingReadMe.txt 70 | 71 | # StyleCop 72 | StyleCopReport.xml 73 | 74 | # Files built by Visual Studio 75 | *_i.c 76 | *_p.c 77 | *_h.h 78 | *.ilk 79 | *.meta 80 | *.obj 81 | *.iobj 82 | *.pch 83 | *.pdb 84 | *.ipdb 85 | *.pgc 86 | *.pgd 87 | *.rsp 88 | *.sbr 89 | *.tlb 90 | *.tli 91 | *.tlh 92 | *.tmp 93 | *.tmp_proj 94 | *_wpftmp.csproj 95 | *.log 96 | *.tlog 97 | *.vspscc 98 | *.vssscc 99 | .builds 100 | *.pidb 101 | *.svclog 102 | *.scc 103 | 104 | # Chutzpah Test files 105 | _Chutzpah* 106 | 107 | # Visual C++ cache files 108 | ipch/ 109 | *.aps 110 | *.ncb 111 | *.opendb 112 | *.opensdf 113 | *.sdf 114 | *.cachefile 115 | *.VC.db 116 | *.VC.VC.opendb 117 | 118 | # Visual Studio profiler 119 | *.psess 120 | *.vsp 121 | *.vspx 122 | *.sap 123 | 124 | # Visual Studio Trace Files 125 | *.e2e 126 | 127 | # TFS 2012 Local Workspace 128 | $tf/ 129 | 130 | # Guidance Automation Toolkit 131 | *.gpState 132 | 133 | # ReSharper is a .NET coding add-in 134 | _ReSharper*/ 135 | *.[Rr]e[Ss]harper 136 | *.DotSettings.user 137 | 138 | # TeamCity is a build add-in 139 | _TeamCity* 140 | 141 | # DotCover is a Code Coverage Tool 142 | *.dotCover 143 | 144 | # AxoCover is a Code Coverage Tool 145 | .axoCover/* 146 | !.axoCover/settings.json 147 | 148 | # Coverlet is a free, cross platform Code Coverage Tool 149 | coverage*.json 150 | coverage*.xml 151 | coverage*.info 152 | 153 | # Visual Studio code coverage results 154 | *.coverage 155 | *.coveragexml 156 | 157 | # NCrunch 158 | _NCrunch_* 159 | .*crunch*.local.xml 160 | nCrunchTemp_* 161 | 162 | # MightyMoose 163 | *.mm.* 164 | AutoTest.Net/ 165 | 166 | # Web workbench (sass) 167 | .sass-cache/ 168 | 169 | # Installshield output folder 170 | [Ee]xpress/ 171 | 172 | # DocProject is a documentation generator add-in 173 | DocProject/buildhelp/ 174 | DocProject/Help/*.HxT 175 | DocProject/Help/*.HxC 176 | DocProject/Help/*.hhc 177 | DocProject/Help/*.hhk 178 | DocProject/Help/*.hhp 179 | DocProject/Help/Html2 180 | DocProject/Help/html 181 | 182 | # Click-Once directory 183 | publish/ 184 | 185 | # Publish Web Output 186 | *.[Pp]ublish.xml 187 | *.azurePubxml 188 | # Note: Comment the next line if you want to checkin your web deploy settings, 189 | # but database connection strings (with potential passwords) will be unencrypted 190 | *.pubxml 191 | *.publishproj 192 | 193 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 194 | # checkin your Azure Web App publish settings, but sensitive information contained 195 | # in these scripts will be unencrypted 196 | PublishScripts/ 197 | 198 | # NuGet Packages 199 | *.nupkg 200 | # NuGet Symbol Packages 201 | *.snupkg 202 | # The packages folder can be ignored because of Package Restore 203 | **/[Pp]ackages/* 204 | # except build/, which is used as an MSBuild target. 205 | !**/[Pp]ackages/build/ 206 | # Uncomment if necessary however generally it will be regenerated when needed 207 | #!**/[Pp]ackages/repositories.config 208 | # NuGet v3's project.json files produces more ignorable files 209 | *.nuget.props 210 | *.nuget.targets 211 | 212 | # Microsoft Azure Build Output 213 | csx/ 214 | *.build.csdef 215 | 216 | # Microsoft Azure Emulator 217 | ecf/ 218 | rcf/ 219 | 220 | # Windows Store app package directories and files 221 | AppPackages/ 222 | BundleArtifacts/ 223 | Package.StoreAssociation.xml 224 | _pkginfo.txt 225 | *.appx 226 | *.appxbundle 227 | *.appxupload 228 | 229 | # Visual Studio cache files 230 | # files ending in .cache can be ignored 231 | *.[Cc]ache 232 | # but keep track of directories ending in .cache 233 | !?*.[Cc]ache/ 234 | 235 | # Others 236 | ClientBin/ 237 | ~$* 238 | *~ 239 | *.dbmdl 240 | *.dbproj.schemaview 241 | *.jfm 242 | *.pfx 243 | *.publishsettings 244 | orleans.codegen.cs 245 | 246 | # Including strong name files can present a security risk 247 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 248 | #*.snk 249 | 250 | # Since there are multiple workflows, uncomment next line to ignore bower_components 251 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 252 | #bower_components/ 253 | 254 | # RIA/Silverlight projects 255 | Generated_Code/ 256 | 257 | # Backup & report files from converting an old project file 258 | # to a newer Visual Studio version. Backup files are not needed, 259 | # because we have git ;-) 260 | _UpgradeReport_Files/ 261 | Backup*/ 262 | UpgradeLog*.XML 263 | UpgradeLog*.htm 264 | ServiceFabricBackup/ 265 | *.rptproj.bak 266 | 267 | # SQL Server files 268 | *.mdf 269 | *.ldf 270 | *.ndf 271 | 272 | # Business Intelligence projects 273 | *.rdl.data 274 | *.bim.layout 275 | *.bim_*.settings 276 | *.rptproj.rsuser 277 | *- [Bb]ackup.rdl 278 | *- [Bb]ackup ([0-9]).rdl 279 | *- [Bb]ackup ([0-9][0-9]).rdl 280 | 281 | # Microsoft Fakes 282 | FakesAssemblies/ 283 | 284 | # GhostDoc plugin setting file 285 | *.GhostDoc.xml 286 | 287 | # Node.js Tools for Visual Studio 288 | .ntvs_analysis.dat 289 | node_modules/ 290 | 291 | # Visual Studio 6 build log 292 | *.plg 293 | 294 | # Visual Studio 6 workspace options file 295 | *.opt 296 | 297 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 298 | *.vbw 299 | 300 | # Visual Studio 6 auto-generated project file (contains which files were open etc.) 301 | *.vbp 302 | 303 | # Visual Studio 6 workspace and project file (working project files containing files to include in project) 304 | *.dsw 305 | *.dsp 306 | 307 | # Visual Studio 6 technical files 308 | *.ncb 309 | *.aps 310 | 311 | # Visual Studio LightSwitch build output 312 | **/*.HTMLClient/GeneratedArtifacts 313 | **/*.DesktopClient/GeneratedArtifacts 314 | **/*.DesktopClient/ModelManifest.xml 315 | **/*.Server/GeneratedArtifacts 316 | **/*.Server/ModelManifest.xml 317 | _Pvt_Extensions 318 | 319 | # Paket dependency manager 320 | .paket/paket.exe 321 | paket-files/ 322 | 323 | # FAKE - F# Make 324 | .fake/ 325 | 326 | # CodeRush personal settings 327 | .cr/personal 328 | 329 | # Python Tools for Visual Studio (PTVS) 330 | __pycache__/ 331 | *.pyc 332 | 333 | # Cake - Uncomment if you are using it 334 | # tools/** 335 | # !tools/packages.config 336 | 337 | # Tabs Studio 338 | *.tss 339 | 340 | # Telerik's JustMock configuration file 341 | *.jmconfig 342 | 343 | # BizTalk build output 344 | *.btp.cs 345 | *.btm.cs 346 | *.odx.cs 347 | *.xsd.cs 348 | 349 | # OpenCover UI analysis results 350 | OpenCover/ 351 | 352 | # Azure Stream Analytics local run output 353 | ASALocalRun/ 354 | 355 | # MSBuild Binary and Structured Log 356 | *.binlog 357 | 358 | # NVidia Nsight GPU debugger configuration file 359 | *.nvuser 360 | 361 | # MFractors (Xamarin productivity tool) working folder 362 | .mfractor/ 363 | 364 | # Local History for Visual Studio 365 | .localhistory/ 366 | 367 | # Visual Studio History (VSHistory) files 368 | .vshistory/ 369 | 370 | # BeatPulse healthcheck temp database 371 | healthchecksdb 372 | 373 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 374 | MigrationBackup/ 375 | 376 | # Ionide (cross platform F# VS Code tools) working folder 377 | .ionide/ 378 | 379 | # Fody - auto-generated XML schema 380 | FodyWeavers.xsd 381 | 382 | # VS Code files for those working on multiple tools 383 | .vscode/* 384 | !.vscode/settings.json 385 | !.vscode/tasks.json 386 | !.vscode/launch.json 387 | !.vscode/extensions.json 388 | *.code-workspace 389 | 390 | # Local History for Visual Studio Code 391 | .history/ 392 | 393 | # Windows Installer files from build outputs 394 | *.cab 395 | *.msi 396 | *.msix 397 | *.msm 398 | *.msp 399 | 400 | # JetBrains Rider 401 | *.sln.iml 402 | 403 | ## 404 | ## Visual studio for Mac 405 | ## 406 | 407 | 408 | # globs 409 | Makefile.in 410 | *.userprefs 411 | *.usertasks 412 | config.make 413 | config.status 414 | aclocal.m4 415 | install-sh 416 | autom4te.cache/ 417 | *.tar.gz 418 | tarballs/ 419 | test-results/ 420 | 421 | # Mac bundle stuff 422 | *.dmg 423 | *.app 424 | 425 | # content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore 426 | # General 427 | .DS_Store 428 | .AppleDouble 429 | .LSOverride 430 | 431 | # Icon must end with two \r 432 | Icon 433 | 434 | 435 | # Thumbnails 436 | ._* 437 | 438 | # Files that might appear in the root of a volume 439 | .DocumentRevisions-V100 440 | .fseventsd 441 | .Spotlight-V100 442 | .TemporaryItems 443 | .Trashes 444 | .VolumeIcon.icns 445 | .com.apple.timemachine.donotpresent 446 | 447 | # Directories potentially created on remote AFP share 448 | .AppleDB 449 | .AppleDesktop 450 | Network Trash Folder 451 | Temporary Items 452 | .apdisk 453 | 454 | # content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore 455 | # Windows thumbnail cache files 456 | Thumbs.db 457 | ehthumbs.db 458 | ehthumbs_vista.db 459 | 460 | # Dump file 461 | *.stackdump 462 | 463 | # Folder config file 464 | [Dd]esktop.ini 465 | 466 | # Recycle Bin used on file shares 467 | $RECYCLE.BIN/ 468 | 469 | # Windows Installer files 470 | *.cab 471 | *.msi 472 | *.msix 473 | *.msm 474 | *.msp 475 | 476 | # Windows shortcuts 477 | *.lnk 478 | 479 | # LiteDB data directory 480 | data/ -------------------------------------------------------------------------------- /Controllers/ManagementController.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | 3 | namespace Kosync.Controllers; 4 | 5 | [ApiController] 6 | public class ManagementController : ControllerBase 7 | { 8 | private ILogger _logger; 9 | 10 | private ProxyService _proxyService; 11 | private IPService _ipService; 12 | private KosyncDb _db; 13 | private UserService _userService; 14 | 15 | 16 | public ManagementController(ILogger logger, ProxyService proxyService, IPService ipService, KosyncDb db, UserService userService) 17 | { 18 | _logger = logger; 19 | _proxyService = proxyService; 20 | _ipService = ipService; 21 | _db = db; 22 | _userService = userService; 23 | } 24 | 25 | [HttpGet("/manage/users")] 26 | public ObjectResult GetUsers() 27 | { 28 | if (!_userService.IsAuthenticated) 29 | { 30 | if (string.IsNullOrEmpty(_userService.Username)) 31 | { 32 | LogWarning("Unauthenticated GET request to /manage/users."); 33 | } 34 | else 35 | { 36 | LogWarning($"Unauthenticated GET request to /manage/users with username [{_userService.Username}]."); 37 | } 38 | 39 | return StatusCode(401, new 40 | { 41 | message = "Unauthorized" 42 | }); 43 | } 44 | 45 | if (!_userService.IsAdmin) 46 | { 47 | LogWarning($"Unauthorized GET request to /manage/users from user [{_userService.Username}]."); 48 | 49 | return StatusCode(401, new 50 | { 51 | message = "Unauthorized" 52 | }); 53 | } 54 | 55 | if (!_userService.IsActive) 56 | { 57 | LogWarning($"GET request to /manage/users received from inactive user [{_userService.Username}]."); 58 | 59 | return StatusCode(401, new 60 | { 61 | message = "Unauthorized" 62 | }); 63 | } 64 | 65 | 66 | var userCollection = _db.Context.GetCollection("users"); 67 | 68 | var users = userCollection.FindAll().Select(i => new 69 | { 70 | id = i.Id, 71 | username = i.Username, 72 | isAdministrator = i.IsAdministrator, 73 | isActive = i.IsActive, 74 | documentCount = i.Documents.Count() 75 | }); 76 | 77 | LogInfo($"User [{_userService.Username}] requested /manage/users"); 78 | return StatusCode(200, users); 79 | } 80 | 81 | [HttpPost("/manage/users")] 82 | public ObjectResult CreateUser(UserCreateRequest payload) 83 | { 84 | if (!_userService.IsAuthenticated) 85 | { 86 | if (string.IsNullOrEmpty(_userService.Username)) 87 | { 88 | LogWarning("Unauthenticated POST request to /manage/users."); 89 | } 90 | else 91 | { 92 | LogWarning($"Unauthenticated POST request to /manage/users with username [{_userService.Username}]."); 93 | } 94 | 95 | return StatusCode(401, new 96 | { 97 | message = "Unauthorized" 98 | }); 99 | } 100 | 101 | if (!_userService.IsAdmin) 102 | { 103 | LogWarning($"Unauthorized POST request to /manage/users from user [{_userService.Username}]."); 104 | 105 | return StatusCode(401, new 106 | { 107 | message = "Unauthorized" 108 | }); 109 | } 110 | 111 | if (!_userService.IsActive) 112 | { 113 | LogWarning($"POST request to /manage/users received from inactive user [{_userService.Username}]."); 114 | 115 | return StatusCode(401, new 116 | { 117 | message = "Unauthorized" 118 | }); 119 | } 120 | 121 | var userCollection = _db.Context.GetCollection("users"); 122 | 123 | var existingUser = userCollection.FindOne(i => i.Username == payload.username); 124 | if (existingUser is not null) 125 | { 126 | return StatusCode(400, new 127 | { 128 | message = "User already exists" 129 | }); 130 | } 131 | 132 | var passwordHash = Utility.HashPassword(payload.password); 133 | 134 | var user = new User() 135 | { 136 | Username = payload.username, 137 | PasswordHash = passwordHash, 138 | IsAdministrator = false 139 | }; 140 | 141 | userCollection.Insert(user); 142 | userCollection.EnsureIndex(u => u.Username); 143 | 144 | LogInfo($"User [{payload.username}] created by user [{_userService.Username}]"); 145 | return StatusCode(200, new 146 | { 147 | message = "User created successfully" 148 | }); 149 | } 150 | 151 | [HttpDelete("/manage/users")] 152 | public ObjectResult DeleteUser(string username) 153 | { 154 | if (!_userService.IsAuthenticated) 155 | { 156 | if (string.IsNullOrEmpty(_userService.Username)) 157 | { 158 | LogWarning("Unauthenticated DELETE request to /manage/users."); 159 | } 160 | else 161 | { 162 | LogWarning($"Unauthenticated DELETE request to /manage/users with username [{_userService.Username}]."); 163 | } 164 | 165 | return StatusCode(401, new 166 | { 167 | message = "Unauthorized" 168 | }); 169 | } 170 | 171 | 172 | if (!_userService.IsAdmin && 173 | !username.Equals(_userService.Username, StringComparison.OrdinalIgnoreCase)) 174 | // allow a user to delete their own account 175 | { 176 | LogWarning($"Unauthorized DELETE request to /manage/users from user [{_userService.Username}]."); 177 | 178 | return StatusCode(401, new 179 | { 180 | message = "Unauthorized" 181 | }); 182 | } 183 | 184 | if (!_userService.IsActive) 185 | { 186 | LogWarning($"DELETE request to /manage/users from inactive user [{_userService.Username}]."); 187 | 188 | return StatusCode(401, new 189 | { 190 | message = "Unauthorized" 191 | }); 192 | } 193 | 194 | var userCollection = _db.Context.GetCollection("users"); 195 | 196 | var user = userCollection.FindOne(u => u.Username == username); 197 | 198 | if (user is null) 199 | { 200 | LogInfo($"DELETE request to /manage/users received from [{_userService.Username}] but target username [{username}] does not exist."); 201 | 202 | return StatusCode(404, new 203 | { 204 | message = "User does not exist" 205 | }); 206 | } 207 | 208 | userCollection.Delete(user.Id); 209 | 210 | LogInfo($"User [{username}] has been deleted by [{_userService.Username}]"); 211 | 212 | return StatusCode(200, new 213 | { 214 | message = "Success" 215 | }); 216 | } 217 | 218 | [HttpGet("/manage/users/documents")] 219 | public ObjectResult GetDocuments(string username) 220 | { 221 | if (!_userService.IsAuthenticated) 222 | { 223 | if (string.IsNullOrEmpty(_userService.Username)) 224 | { 225 | LogWarning("Unauthenticated GET request to /manage/users/documents."); 226 | } 227 | else 228 | { 229 | LogWarning($"Unauthenticated GET request to /manage/users/documents with username [{_userService.Username}]."); 230 | } 231 | 232 | return StatusCode(401, new 233 | { 234 | message = "Unauthorized" 235 | }); 236 | } 237 | 238 | 239 | if (!_userService.IsAdmin && 240 | !username.Equals(_userService.Username, StringComparison.OrdinalIgnoreCase)) 241 | // allow a user to request their own docs 242 | { 243 | LogWarning($"Unauthorized GET request to /manage/users/documents from user [{_userService.Username}]."); 244 | 245 | return StatusCode(401, new 246 | { 247 | message = "Unauthorized" 248 | }); 249 | } 250 | 251 | if (!_userService.IsActive) 252 | { 253 | LogWarning($"GET request to /manage/users/documents received from inactive user [{_userService.Username}]."); 254 | 255 | return StatusCode(401, new 256 | { 257 | message = "Unauthorized" 258 | }); 259 | } 260 | 261 | LogInfo($"User [{username}]'s documents requested by [{_userService.Username}]"); 262 | 263 | var userCollection = _db.Context.GetCollection("users"); 264 | 265 | var user = userCollection.FindOne(i => i.Username == username); 266 | if (user is null) 267 | { 268 | return StatusCode(400, new 269 | { 270 | message = "User does not exist" 271 | }); 272 | } 273 | 274 | return StatusCode(200, user.Documents); 275 | } 276 | 277 | [HttpDelete("/manage/users/documents")] 278 | public ObjectResult DeleteUserDocument(string username, string documentHash) 279 | { 280 | if (!_userService.IsAuthenticated) 281 | { 282 | if (string.IsNullOrEmpty(_userService.Username)) 283 | { 284 | LogWarning("Unauthenticated DELETE request to /manage/users/documents."); 285 | } 286 | else 287 | { 288 | LogWarning($"Unauthenticated DELETE request to /manage/users/documents with username [{_userService.Username}]."); 289 | } 290 | 291 | return StatusCode(401, new 292 | { 293 | message = "Unauthorized" 294 | }); 295 | } 296 | 297 | if (!_userService.IsAdmin && 298 | !username.Equals(_userService.Username, StringComparison.OrdinalIgnoreCase)) 299 | { 300 | LogWarning($"Unauthorized DELETE request to /manage/users/documents from user [{_userService.Username}]."); 301 | 302 | return StatusCode(401, new 303 | { 304 | message = "Unauthorized" 305 | }); 306 | } 307 | 308 | if (!_userService.IsActive) 309 | { 310 | LogWarning($"DELETE request to /manage/users/documents from inactive user [{_userService.Username}]."); 311 | 312 | return StatusCode(401, new 313 | { 314 | message = "Unauthorized" 315 | }); 316 | } 317 | 318 | var userCollection = _db.Context.GetCollection("users").Include(i => i.Documents); 319 | 320 | var user = userCollection.FindOne(i => i.Username == username); 321 | 322 | var document = user.Documents.SingleOrDefault(i => i.DocumentHash == documentHash); 323 | 324 | if (document is null) 325 | { 326 | return StatusCode(404, new 327 | { 328 | message = $"Document hash [{documentHash}] was not found for user [{username}]." 329 | }); 330 | } 331 | 332 | user.Documents.Remove(document); 333 | 334 | userCollection.Update(user); 335 | 336 | LogInfo($"User [{_userService.Username}] deleted document with hash [{documentHash}] for user [{username}]."); 337 | 338 | return StatusCode(200, new 339 | { 340 | message = "Success" 341 | }); 342 | } 343 | 344 | [HttpPut("/manage/users/active")] 345 | public ObjectResult UpdateUserActive(string username) 346 | { 347 | if (!_userService.IsAuthenticated) 348 | { 349 | if (string.IsNullOrEmpty(_userService.Username)) 350 | { 351 | LogWarning("Unauthenticated PUT request to /manage/users/active."); 352 | } 353 | else 354 | { 355 | LogWarning($"Unauthenticated PUT request to /manage/users/active with username [{_userService.Username}]."); 356 | } 357 | 358 | return StatusCode(401, new 359 | { 360 | message = "Unauthorized" 361 | }); 362 | } 363 | 364 | if (!_userService.IsAdmin) 365 | { 366 | LogWarning($"Unauthorized PUT request to /manage/users/active from user [{_userService.Username}]."); 367 | 368 | return StatusCode(401, new 369 | { 370 | message = "Unauthorized" 371 | }); 372 | } 373 | 374 | if (!_userService.IsActive) 375 | { 376 | LogWarning($"PUT request to /manage/users/active received from inactive user [{_userService.Username}]."); 377 | 378 | return StatusCode(401, new 379 | { 380 | message = "Unauthorized" 381 | }); 382 | } 383 | 384 | if (username == "admin") 385 | { 386 | LogWarning($"Attempt to toggle admin user active from user [{_userService.Username}]."); 387 | 388 | return StatusCode(400, new 389 | { 390 | message = "Cannot update admin user" 391 | }); 392 | } 393 | 394 | var userCollection = _db.Context.GetCollection("users"); 395 | 396 | var user = userCollection.FindOne(i => i.Username == username); 397 | if (user is null) 398 | { 399 | LogInfo($"PUT request to /manage/users/active received from [{_userService.Username}] but target username [{username}] does not exist."); 400 | 401 | return StatusCode(400, new 402 | { 403 | message = "User does not exist" 404 | }); 405 | } 406 | 407 | user.IsActive = !user.IsActive; 408 | userCollection.Update(user); 409 | 410 | LogInfo($"User [{username}] set to {(user.IsActive ? "active" : "inactive")} by user [{_userService.Username}]"); 411 | 412 | return StatusCode(200, new 413 | { 414 | message = user.IsActive ? "User marked as active" : "User marked as inactive" 415 | }); 416 | } 417 | 418 | [HttpPut("/manage/users/password")] 419 | public ObjectResult UpdatePassword(string username, PasswordChangeRequest payload) 420 | { 421 | if (!_userService.IsAuthenticated) 422 | { 423 | if (string.IsNullOrEmpty(_userService.Username)) 424 | { 425 | LogWarning("Unauthenticated PUT request to /manage/users/password."); 426 | } 427 | else 428 | { 429 | LogWarning($"Unauthenticated PUT request to /manage/users/password with username [{_userService.Username}]."); 430 | } 431 | 432 | return StatusCode(401, new 433 | { 434 | message = "Unauthorized" 435 | }); 436 | } 437 | 438 | if (!_userService.IsAdmin) 439 | { 440 | LogWarning($"Unauthorized PUT request to /manage/users/password from user [{_userService.Username}]."); 441 | 442 | return StatusCode(401, new 443 | { 444 | message = "Unauthorized" 445 | }); 446 | } 447 | 448 | if (!_userService.IsActive) 449 | { 450 | LogWarning($"PUT request to /manage/users/password received from inactive user [{_userService.Username}]."); 451 | 452 | return StatusCode(401, new 453 | { 454 | message = "Unauthorized" 455 | }); 456 | } 457 | 458 | // KOReader will literally not attempt to log in with a blank password field or with just whitespace 459 | if (string.IsNullOrWhiteSpace(payload.password)) 460 | { 461 | return StatusCode(400, new 462 | { 463 | message = "Password cannot be empty or whitespace" 464 | }); 465 | } 466 | 467 | if (username == "admin") 468 | { 469 | LogWarning($"Attempt to change admin password from user [{_userService.Username}]."); 470 | return StatusCode(400, new 471 | { 472 | message = "Cannot update admin user" 473 | }); 474 | } 475 | 476 | var userCollection = _db.Context.GetCollection("users"); 477 | 478 | var user = userCollection.FindOne(i => i.Username == username); 479 | if (user is null) 480 | { 481 | LogWarning($"Password change request received from [{_userService.Username}] but target username [{username}] does not exist."); 482 | return StatusCode(400, new 483 | { 484 | message = "User does not exist" 485 | }); 486 | } 487 | 488 | user.PasswordHash = Utility.HashPassword(payload.password); 489 | userCollection.Update(user); 490 | 491 | LogInfo($"User [{username}]'s password updated by [{_userService.Username}]."); 492 | return StatusCode(200, new 493 | { 494 | message = "Password changed successfully" 495 | }); 496 | } 497 | 498 | private void LogInfo(string text) 499 | { 500 | Log(LogLevel.Information, text); 501 | } 502 | 503 | private void LogWarning(string text) 504 | { 505 | Log(LogLevel.Warning, text); 506 | } 507 | 508 | private void Log(LogLevel level, string text) 509 | { 510 | string logMsg = $"[{DateTime.Now.ToString("yyyy/MM/dd HH:mm:ss")}] [{_ipService.ClientIP}]"; 511 | 512 | 513 | // If trusted proxies are set but this request comes from another address, mark it 514 | if (_proxyService.TrustedProxies.Length > 0 && 515 | !_ipService.TrustedProxy) 516 | { 517 | logMsg += "*"; 518 | } 519 | 520 | logMsg += $" {text}"; 521 | 522 | _logger?.Log(level, logMsg); 523 | } 524 | } -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------