├── .gitignore ├── .github ├── workflows │ ├── build-dotnet.yml │ └── codeql-analysis.yml └── dependabot.yml ├── Jellyfin.Plugin.Keycloak.sln ├── Jellyfin.Plugin.Keycloak ├── KeycloakUser.cs ├── Jellyfin.Plugin.Keycloak.csproj ├── KeycloakTokenResponse.cs ├── Plugin.cs ├── Configuration │ ├── PluginConfiguration.cs │ └── configPage.html └── KeyCloakAuthenticationProviderPlugin.cs ├── README.md ├── jellyfin.ruleset ├── .editorconfig └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | bin/ 2 | obj/ 3 | .idea/ 4 | *.DotSettings.user 5 | .vs/ 6 | -------------------------------------------------------------------------------- /.github/workflows/build-dotnet.yml: -------------------------------------------------------------------------------- 1 | name: Test Build Plugin 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v2 14 | 15 | - name: "Setup .NET Core" 16 | uses: actions/setup-dotnet@v1 17 | with: 18 | dotnet-version: "6.0.x" 19 | 20 | - name: "Install dependencies" 21 | run: dotnet restore 22 | 23 | - name: "Build" 24 | run: dotnet build --configuration Release 25 | 26 | - name: "Test" 27 | run: dotnet test --no-restore --verbosity normal 28 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Fetch and update latest `nuget` pkgs 4 | - package-ecosystem: "nuget" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | time: "00:00" 9 | open-pull-requests-limit: 10 10 | commit-message: 11 | prefix: "chore" 12 | include: "scope" 13 | 14 | # Fetch and update latest `github-actions` pkgs 15 | - package-ecosystem: "github-actions" 16 | directory: "/" 17 | schedule: 18 | interval: "weekly" 19 | time: "00:00" 20 | labels: 21 | - "skip-changelog" 22 | open-pull-requests-limit: 10 23 | commit-message: 24 | prefix: "ci" 25 | include: "scope" 26 | 27 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak.sln: -------------------------------------------------------------------------------- 1 | Microsoft Visual Studio Solution File, Format Version 12.00 2 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.Keycloak", "Jellyfin.Plugin.Keycloak\Jellyfin.Plugin.Keycloak.csproj", "{D921B930-CF91-406F-ACBC-08914DCD0D34}" 3 | EndProject 4 | Global 5 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 6 | Debug|Any CPU = Debug|Any CPU 7 | Release|Any CPU = Release|Any CPU 8 | EndGlobalSection 9 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 10 | {D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 11 | {D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|Any CPU.Build.0 = Debug|Any CPU 12 | {D921B930-CF91-406F-ACBC-08914DCD0D34}.Release|Any CPU.ActiveCfg = Release|Any CPU 13 | {D921B930-CF91-406F-ACBC-08914DCD0D34}.Release|Any CPU.Build.0 = Release|Any CPU 14 | EndGlobalSection 15 | EndGlobal 16 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | name: Run CodeQL 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | schedule: 9 | - cron: '24 2 * * 4' 10 | 11 | jobs: 12 | analyze: 13 | name: Analyze 14 | runs-on: ubuntu-latest 15 | 16 | strategy: 17 | fail-fast: false 18 | matrix: 19 | language: [ 'csharp' ] 20 | 21 | steps: 22 | - name: Checkout repository 23 | uses: actions/checkout@v2 24 | 25 | - name: Setup .NET Core 26 | uses: actions/setup-dotnet@v1 27 | with: 28 | dotnet-version: 6.0.x 29 | 30 | - name: Initialize CodeQL 31 | uses: github/codeql-action/init@v1 32 | with: 33 | languages: ${{ matrix.language }} 34 | queries: +security-and-quality 35 | 36 | - name: Autobuild 37 | uses: github/codeql-action/autobuild@v1 38 | 39 | - name: Perform CodeQL Analysis 40 | uses: github/codeql-action/analyze@v1 41 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/KeycloakUser.cs: -------------------------------------------------------------------------------- 1 | using System.Collections.ObjectModel; 2 | using Microsoft.VisualBasic; 3 | 4 | namespace Jellyfin.Plugin.Keycloak 5 | { 6 | /// 7 | /// User Model for Keycloak Users. 8 | /// 9 | public class KeycloakUser 10 | { 11 | /// 12 | /// Initializes a new instance of the class. 13 | /// 14 | /// Instance of the username of the user. 15 | public KeycloakUser(string username) 16 | { 17 | Username = username; 18 | Permissions = new Collection(); 19 | } 20 | 21 | /// 22 | /// Gets or sets the value of the username of an user. 23 | /// 24 | public string Username { get; set; } 25 | 26 | /// 27 | /// Gets the value of permissions of an user. 28 | /// 29 | public Collection Permissions { get; } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/Jellyfin.Plugin.Keycloak.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | 2.0.0.0 6 | 2.0.0.0 7 | true 8 | true 9 | enable 10 | AllEnabledByDefault 11 | ../jellyfin.ruleset 12 | CA1819 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Keycloak Authentication Plugin 2 | 3 | A simple plugin for Jellyfin to authenticate against a Keycloak instance. 4 | 5 | ## Requirements 6 | * Your keycloak client config needs to have `Direct Access Grants Enabled` enabled. 7 | * You need to add the following roles your defined client `administrator`, `allowed_access`, `allow_media_downloads` 8 | * Map at least `allowed_access` to the users you want to be able to access jellyfin (or map it to a group) 9 | 10 | 11 | ## Limitations 12 | * This only provides a an authentication method against Keycloak, it does not handle token renewal/revoking. 13 | eg: If you delete/invalidate/etc a users session/account in keycloak the session will remain active in Jellyfin. 14 | (However if you remove the `allowed_access` role and the user logs in again all sessions in Jellyfin are revoked.) 15 | 16 | * It does not provide a true 'Single Sign On' as if the user is signed into the Realm already the user will still be prompted to authenticate to Jellyfin. 17 | 18 | * It does not follow oauth2 or oidc worflow, it mearly requests a token from keycloak with the username/password provided if we get a token we mark the authentication request as successfull. 19 | 20 | ## Build/Installation 21 | 1. Have .NET SDK 5.0 22 | 2. `dotnet publish --configuration Release --output bin` 23 | 3. Make a directory called `keycloak` (or whatever you want) in your jellyfin keycloak directory 24 | Windows: `%localappdata%\jellyfin\plugins` 25 | Linux: `/var/lib/jellyfin/plugins` 26 | Place the built `Jellyfin.Plugin.Keycloak.dll` and `JWT.dll` in the directory and restart Jellyfin 27 | 4. Configure the plugin in the webui `Admin Dashboard -> Advanced -> Plugins` 28 | 29 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/KeycloakTokenResponse.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.Serialization; 2 | using System.Text.Json.Serialization; 3 | 4 | namespace Jellyfin.Plugin.Keycloak 5 | { 6 | /// 7 | /// Response model for the keycloak token. 8 | /// 9 | [DataContract] 10 | public class KeycloakTokenResponse 11 | { 12 | /// 13 | /// Gets or sets the access token instance. 14 | /// 15 | [JsonPropertyName("access_token")] 16 | public string? AccessToken { get; set; } 17 | 18 | /// 19 | /// Gets or sets the expiry time instance. 20 | /// 21 | [JsonPropertyName("expires_in")] 22 | public int ExpiresIn { get; set; } 23 | 24 | /// 25 | /// Gets or sets the not-before-policy instance. 26 | /// 27 | [JsonPropertyName("not-before-policy")] 28 | public int NotBeforePolicy { get; set; } 29 | 30 | /// 31 | /// Gets or sets the refresh token instance. 32 | /// 33 | [JsonPropertyName("refresh_token")] 34 | public string? RefreshToken { get; set; } 35 | 36 | /// 37 | /// Gets or sets the scope instance. 38 | /// 39 | [JsonPropertyName("scope")] 40 | public string? Scope { get; set; } 41 | 42 | /// 43 | /// Gets or sets the session state instance. 44 | /// 45 | [JsonPropertyName("session_state")] 46 | public string? SessionState { get; set; } 47 | 48 | /// 49 | /// Gets or sets the token type instance. 50 | /// 51 | [JsonPropertyName("token_type")] 52 | public string? TokenType { get; set; } 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/Plugin.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using Jellyfin.Plugin.Keycloak.Configuration; 4 | using MediaBrowser.Common.Configuration; 5 | using MediaBrowser.Common.Plugins; 6 | using MediaBrowser.Model.Plugins; 7 | using MediaBrowser.Model.Serialization; 8 | 9 | namespace Jellyfin.Plugin.Keycloak 10 | { 11 | /// 12 | /// Keycloak Plugin. 13 | /// 14 | public class Plugin : BasePlugin, IHasWebPages 15 | { 16 | /// 17 | /// Initializes a new instance of the class. 18 | /// 19 | /// Instance of the interface. 20 | /// Instance of the interface. 21 | public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) : base(applicationPaths, xmlSerializer) 22 | { 23 | Instance = this; 24 | } 25 | 26 | /// 27 | /// Gets the plugin instance. 28 | /// 29 | public static Plugin Instance { get; private set; } = null!; 30 | 31 | /// 32 | public override string Name => "Keycloak-Auth"; 33 | 34 | /// 35 | public override Guid Id => Guid.Parse("40886866-b3dd-4d6a-bf9b-25c83e6c3d10"); 36 | 37 | /// 38 | public IEnumerable GetPages() 39 | { 40 | return new[] 41 | { 42 | new PluginPageInfo 43 | { 44 | Name = this.Name, 45 | EmbeddedResourcePath = $"{GetType().Namespace}.Configuration.configPage.html" 46 | } 47 | }; 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/Configuration/PluginConfiguration.cs: -------------------------------------------------------------------------------- 1 | using MediaBrowser.Model.Plugins; 2 | 3 | namespace Jellyfin.Plugin.Keycloak.Configuration; 4 | 5 | /// 6 | /// The main plugin. 7 | /// 8 | public class PluginConfiguration : BasePluginConfiguration 9 | { 10 | /// 11 | /// Initializes a new instance of the class. 12 | /// 13 | public PluginConfiguration() 14 | { 15 | // set default options here 16 | this.CreateUser = true; 17 | this.Enable2Fa = false; 18 | this.AuthServerUrl = string.Empty; 19 | this.Realm = string.Empty; 20 | this.Resource = string.Empty; 21 | this.ClientSecret = string.Empty; 22 | } 23 | 24 | /// 25 | /// Gets or sets a value indicating whether an user from keycloak exists Jellyfin. 26 | /// 27 | public bool CreateUser { get; set; } 28 | 29 | /// 30 | /// Gets or sets a value indicating whether an user from keycloak exists Jellyfin. 31 | /// 32 | public bool Enable2Fa { get; set; } 33 | 34 | /// 35 | /// Gets or sets a value indicating whether an user from keycloak exists Jellyfin. 36 | /// 37 | public string AuthServerUrl { get; set; } 38 | 39 | /// 40 | /// Gets or sets a value indicating whether an user from keycloak exists Jellyfin. 41 | /// 42 | public string Realm { get; set; } 43 | 44 | /// 45 | /// Gets or sets a value indicating whether an user from keycloak exists Jellyfin. 46 | /// 47 | public string Resource { get; set; } 48 | 49 | /// 50 | /// Gets or sets a value indicating whether an user from keycloak exists Jellyfin. 51 | /// 52 | public string ClientSecret { get; set; } 53 | } 54 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/Configuration/configPage.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Keycloak 6 | 7 | 8 |
9 |
10 |
11 |
12 |
13 | 17 |
BIGHACK: add _2FA=CODEHERE to end of password when loging in
18 |
19 |
20 | 24 |
25 |
26 | 27 | 28 |
Base Keycloak auth URI
29 |
30 |
31 | 32 | 33 |
Keycloak Realm
34 |
35 |
36 | 37 | 38 |
Keycloak Resource/Client
39 |
40 |
41 | 42 | 43 |
Client Secret
44 |
45 |
46 | 49 |
50 |
51 |
52 |
53 | 96 |
97 | 98 | 99 | -------------------------------------------------------------------------------- /jellyfin.ruleset: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # With more recent updates Visual Studio 2017 supports EditorConfig files out of the box 2 | # Visual Studio Code needs an extension: https://github.com/editorconfig/editorconfig-vscode 3 | # For emacs, vim, np++ and other editors, see here: https://github.com/editorconfig 4 | ############################### 5 | # Core EditorConfig Options # 6 | ############################### 7 | root = true 8 | 9 | # All files 10 | [*] 11 | indent_style = space 12 | indent_size = 4 13 | charset = utf-8 14 | trim_trailing_whitespace = true 15 | insert_final_newline = true 16 | end_of_line = lf 17 | max_line_length = 9999 18 | 19 | # YAML indentation 20 | [*.{yml,yaml}] 21 | indent_size = 2 22 | 23 | # XML indentation 24 | [*.{csproj,xml}] 25 | indent_size = 2 26 | 27 | ############################### 28 | # .NET Coding Conventions # 29 | ############################### 30 | 31 | [*.{cs,vb}] 32 | # Organize usings 33 | dotnet_sort_system_directives_first = true 34 | # this. preferences 35 | dotnet_style_qualification_for_field = false:silent 36 | dotnet_style_qualification_for_property = false:silent 37 | dotnet_style_qualification_for_method = false:silent 38 | dotnet_style_qualification_for_event = false:silent 39 | # Language keywords vs BCL types preferences 40 | dotnet_style_predefined_type_for_locals_parameters_members = true:silent 41 | dotnet_style_predefined_type_for_member_access = true:silent 42 | # Parentheses preferences 43 | dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent 44 | dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent 45 | dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent 46 | dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent 47 | # Modifier preferences 48 | dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent 49 | dotnet_style_readonly_field = true:suggestion 50 | # Expression-level preferences 51 | dotnet_style_object_initializer = true:suggestion 52 | dotnet_style_collection_initializer = true:suggestion 53 | dotnet_style_explicit_tuple_names = true:suggestion 54 | dotnet_style_null_propagation = true:suggestion 55 | dotnet_style_coalesce_expression = true:suggestion 56 | dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent 57 | dotnet_style_prefer_inferred_tuple_names = true:suggestion 58 | dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion 59 | dotnet_style_prefer_auto_properties = true:silent 60 | dotnet_style_prefer_conditional_expression_over_assignment = true:silent 61 | dotnet_style_prefer_conditional_expression_over_return = true:silent 62 | 63 | ############################### 64 | # Naming Conventions # 65 | ############################### 66 | 67 | # Style Definitions (From Roslyn) 68 | 69 | # Non-private static fields are PascalCase 70 | dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion 71 | dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields 72 | dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style 73 | 74 | dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field 75 | dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected 76 | dotnet_naming_symbols.non_private_static_fields.required_modifiers = static 77 | 78 | dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case 79 | 80 | # Constants are PascalCase 81 | dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion 82 | dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants 83 | dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style 84 | 85 | dotnet_naming_symbols.constants.applicable_kinds = field, local 86 | dotnet_naming_symbols.constants.required_modifiers = const 87 | 88 | dotnet_naming_style.constant_style.capitalization = pascal_case 89 | 90 | # Static fields are camelCase and start with s_ 91 | dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion 92 | dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields 93 | dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style 94 | 95 | dotnet_naming_symbols.static_fields.applicable_kinds = field 96 | dotnet_naming_symbols.static_fields.required_modifiers = static 97 | 98 | dotnet_naming_style.static_field_style.capitalization = camel_case 99 | dotnet_naming_style.static_field_style.required_prefix = _ 100 | 101 | # Instance fields are camelCase and start with _ 102 | dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion 103 | dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields 104 | dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style 105 | 106 | dotnet_naming_symbols.instance_fields.applicable_kinds = field 107 | 108 | dotnet_naming_style.instance_field_style.capitalization = camel_case 109 | dotnet_naming_style.instance_field_style.required_prefix = _ 110 | 111 | # Locals and parameters are camelCase 112 | dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion 113 | dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters 114 | dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style 115 | 116 | dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local 117 | 118 | dotnet_naming_style.camel_case_style.capitalization = camel_case 119 | 120 | # Local functions are PascalCase 121 | dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion 122 | dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions 123 | dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style 124 | 125 | dotnet_naming_symbols.local_functions.applicable_kinds = local_function 126 | 127 | dotnet_naming_style.local_function_style.capitalization = pascal_case 128 | 129 | # By default, name items with PascalCase 130 | dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion 131 | dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members 132 | dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style 133 | 134 | dotnet_naming_symbols.all_members.applicable_kinds = * 135 | 136 | dotnet_naming_style.pascal_case_style.capitalization = pascal_case 137 | 138 | ############################### 139 | # C# Coding Conventions # 140 | ############################### 141 | 142 | [*.cs] 143 | # var preferences 144 | csharp_style_var_for_built_in_types = true:silent 145 | csharp_style_var_when_type_is_apparent = true:silent 146 | csharp_style_var_elsewhere = true:silent 147 | # Expression-bodied members 148 | csharp_style_expression_bodied_methods = false:silent 149 | csharp_style_expression_bodied_constructors = false:silent 150 | csharp_style_expression_bodied_operators = false:silent 151 | csharp_style_expression_bodied_properties = true:silent 152 | csharp_style_expression_bodied_indexers = true:silent 153 | csharp_style_expression_bodied_accessors = true:silent 154 | # Pattern matching preferences 155 | csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion 156 | csharp_style_pattern_matching_over_as_with_null_check = true:suggestion 157 | # Null-checking preferences 158 | csharp_style_throw_expression = true:suggestion 159 | csharp_style_conditional_delegate_call = true:suggestion 160 | # Modifier preferences 161 | csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion 162 | # Expression-level preferences 163 | csharp_prefer_braces = true:silent 164 | csharp_style_deconstructed_variable_declaration = true:suggestion 165 | csharp_prefer_simple_default_expression = true:suggestion 166 | csharp_style_pattern_local_over_anonymous_function = true:suggestion 167 | csharp_style_inlined_variable_declaration = true:suggestion 168 | 169 | ############################### 170 | # C# Formatting Rules # 171 | ############################### 172 | 173 | # New line preferences 174 | csharp_new_line_before_open_brace = all 175 | csharp_new_line_before_else = true 176 | csharp_new_line_before_catch = true 177 | csharp_new_line_before_finally = true 178 | csharp_new_line_before_members_in_object_initializers = true 179 | csharp_new_line_before_members_in_anonymous_types = true 180 | csharp_new_line_between_query_expression_clauses = true 181 | # Indentation preferences 182 | csharp_indent_case_contents = true 183 | csharp_indent_switch_labels = true 184 | csharp_indent_labels = flush_left 185 | # Space preferences 186 | csharp_space_after_cast = false 187 | csharp_space_after_keywords_in_control_flow_statements = true 188 | csharp_space_between_method_call_parameter_list_parentheses = false 189 | csharp_space_between_method_declaration_parameter_list_parentheses = false 190 | csharp_space_between_parentheses = false 191 | csharp_space_before_colon_in_inheritance_clause = true 192 | csharp_space_after_colon_in_inheritance_clause = true 193 | csharp_space_around_binary_operators = before_and_after 194 | csharp_space_between_method_declaration_empty_parameter_list_parentheses = false 195 | csharp_space_between_method_call_name_and_opening_parenthesis = false 196 | csharp_space_between_method_call_empty_parameter_list_parentheses = false 197 | # Wrapping preferences 198 | csharp_preserve_single_line_statements = true 199 | csharp_preserve_single_line_blocks = true 200 | -------------------------------------------------------------------------------- /Jellyfin.Plugin.Keycloak/KeyCloakAuthenticationProviderPlugin.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Collections.ObjectModel; 4 | using System.Net.Http; 5 | using System.Text.Json; 6 | using System.Text.RegularExpressions; 7 | using System.Threading.Tasks; 8 | using Jellyfin.Data.Entities; 9 | using Jellyfin.Data.Enums; 10 | using JWT.Builder; 11 | using MediaBrowser.Common; 12 | using MediaBrowser.Common.Net; 13 | using MediaBrowser.Controller.Authentication; 14 | using MediaBrowser.Controller.Library; 15 | using MediaBrowser.Controller.Session; 16 | using Microsoft.Extensions.Logging; 17 | using Newtonsoft.Json.Linq; 18 | 19 | namespace Jellyfin.Plugin.Keycloak 20 | { 21 | /// 22 | /// KeyCloak Authentication Provider Plugin. 23 | /// 24 | public class KeyCloakAuthenticationProviderPlugin : IAuthenticationProvider 25 | { 26 | private readonly IHttpClientFactory _httpClientFactory; 27 | private readonly ILogger _logger; 28 | private readonly IApplicationHost _applicationHost; 29 | private string _twoFactorPattern = @"(.*)_2FA=(.*)$"; 30 | 31 | /// 32 | /// Initializes a new instance of the class. 33 | /// 34 | /// Instance of the interface. 35 | /// Instance of the interface. 36 | /// Instance of the interface. 37 | public KeyCloakAuthenticationProviderPlugin( 38 | IHttpClientFactory httpClientFactory, 39 | IApplicationHost applicationHost, 40 | ILogger logger) 41 | { 42 | _logger = logger; 43 | _httpClientFactory = httpClientFactory; 44 | _applicationHost = applicationHost; 45 | } 46 | 47 | private static bool CreateUser => Plugin.Instance.Configuration.CreateUser; 48 | 49 | private static string AuthServerUrl => Plugin.Instance.Configuration.AuthServerUrl; 50 | 51 | private static string Realm => Plugin.Instance.Configuration.Realm; 52 | 53 | private static string Resource => Plugin.Instance.Configuration.Resource; 54 | 55 | private static string ClientSecret => Plugin.Instance.Configuration.ClientSecret; 56 | 57 | private static bool Enable2Fa => Plugin.Instance.Configuration.Enable2Fa; 58 | 59 | private string TokenUri => $"{AuthServerUrl}/realms/{Realm}/protocol/openid-connect/token"; 60 | 61 | /// 62 | public string Name => "Keycloak-Authentication"; 63 | 64 | /// 65 | public bool IsEnabled => true; 66 | 67 | private HttpClient GetHttpClient() 68 | { 69 | return _httpClientFactory.CreateClient(NamedClient.Default); 70 | } 71 | 72 | private async Task GetKeycloakUser(string username, string password, string? totp) 73 | { 74 | var httpClient = GetHttpClient(); 75 | var keyValues = new List>(); 76 | keyValues.Add(new KeyValuePair("username", username)); 77 | keyValues.Add(new KeyValuePair("password", password)); 78 | keyValues.Add(new KeyValuePair("grant_type", "password")); 79 | keyValues.Add(new KeyValuePair("client_id", Resource)); 80 | if (!string.IsNullOrWhiteSpace(ClientSecret)) 81 | { 82 | keyValues.Add(new KeyValuePair("client_secret", ClientSecret)); 83 | } 84 | 85 | if (!string.IsNullOrWhiteSpace(totp)) 86 | { 87 | keyValues.Add(new KeyValuePair("totp", totp)); 88 | } 89 | 90 | var content = new FormUrlEncodedContent(keyValues); 91 | var response = await httpClient.PostAsync(TokenUri, content).ConfigureAwait(false); 92 | var responseStream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false); 93 | KeycloakTokenResponse? parsed = await JsonSerializer.DeserializeAsync(responseStream).ConfigureAwait(false); 94 | if (parsed == null) 95 | { 96 | return null; 97 | } 98 | 99 | try 100 | { 101 | var jwtToken = JwtBuilder.Create().Decode>(parsed.AccessToken); 102 | Collection perms = new Collection(); 103 | try 104 | { 105 | var resourceAccess = (JObject)jwtToken["resource_access"]; 106 | perms = ((JArray)((JObject)resourceAccess[Resource])["roles"]).ToObject>(); 107 | } 108 | catch (Exception ex) 109 | { 110 | _logger.LogError(ex, "Could not parse permissions for resource: {Resource}", Resource); 111 | } 112 | 113 | KeycloakUser user = new KeycloakUser(username); 114 | foreach (var perm in perms) 115 | { 116 | user.Permissions.Add(perm); 117 | } 118 | 119 | return user; 120 | } 121 | catch (Exception ex) 122 | { 123 | _logger.LogError(ex, "Error parsing jwt token"); 124 | } 125 | 126 | return null; 127 | } 128 | 129 | private async Task UpdateUserInfo(KeycloakUser? keycloakUser, User? jellyfinUser) 130 | { 131 | var userManager = _applicationHost.Resolve(); 132 | if (jellyfinUser != null) 133 | { 134 | jellyfinUser.SetPermission(PermissionKind.IsDisabled, true); 135 | jellyfinUser.SetPermission(PermissionKind.IsAdministrator, false); 136 | jellyfinUser.SetPermission(PermissionKind.EnableContentDownloading, false); 137 | if (keycloakUser != null) 138 | { 139 | foreach (string permission in keycloakUser.Permissions) 140 | { 141 | switch (permission) 142 | { 143 | case "administrator": 144 | jellyfinUser.SetPermission(PermissionKind.IsAdministrator, true); 145 | break; 146 | case "allowed_access": 147 | jellyfinUser.SetPermission(PermissionKind.IsDisabled, false); 148 | break; 149 | } 150 | } 151 | } 152 | 153 | await userManager.UpdateUserAsync(jellyfinUser).ConfigureAwait(false); 154 | } 155 | } 156 | 157 | /// 158 | public async Task Authenticate(string username, string password) 159 | { 160 | var userManager = _applicationHost.Resolve(); 161 | string? totp = null; 162 | if (Enable2Fa) 163 | { 164 | var match = Regex.Match(password, _twoFactorPattern); 165 | if (match.Success) 166 | { 167 | password = match.Groups[1].Value; 168 | totp = match.Groups[2].Value; 169 | } 170 | } 171 | 172 | User? user = null; 173 | try 174 | { 175 | user = userManager.GetUserByName(username); 176 | } 177 | catch (Exception e) 178 | { 179 | _logger.LogWarning("User Manager could not find a user for Keycloak User, this may not be fatal: {E}", e); 180 | } 181 | 182 | KeycloakUser? keycloakUser = await GetKeycloakUser(username, password, totp).ConfigureAwait(false); 183 | if (keycloakUser == null) 184 | { 185 | throw new AuthenticationException("Error completing Keycloak login. Invalid username or password."); 186 | } 187 | 188 | if (user == null) 189 | { 190 | if (CreateUser) 191 | { 192 | _logger.LogInformation("Creating user: {Username}", username); 193 | user = await userManager.CreateUserAsync(username).ConfigureAwait(false); 194 | var userAuthenticationProviderId = GetType().FullName; 195 | if (userAuthenticationProviderId != null) 196 | { 197 | user.AuthenticationProviderId = userAuthenticationProviderId; 198 | } 199 | 200 | await UpdateUserInfo(keycloakUser, user).ConfigureAwait(false); 201 | } 202 | else 203 | { 204 | _logger.LogError("Keycloak User not configured for Jellyfin: {Username}", username); 205 | throw new AuthenticationException( 206 | $"Automatic User Creation is disabled and there is no Jellyfin user for authorized Uid: {username}"); 207 | } 208 | } 209 | else 210 | { 211 | await UpdateUserInfo(keycloakUser, user).ConfigureAwait(false); 212 | } 213 | 214 | if (user != null && user.HasPermission(PermissionKind.IsDisabled)) 215 | { 216 | // If the user no longer has permission to access revoke all sessions for this user 217 | _logger.LogInformation("{Username} is disabled, revoking all sessions", username); 218 | var sessionHandler = _applicationHost.Resolve(); 219 | await sessionHandler.RevokeUserTokens(user.Id, null).ConfigureAwait(false); 220 | } 221 | 222 | return new ProviderAuthenticationResult { Username = username }; 223 | } 224 | 225 | /// 226 | public bool HasPassword(User user) 227 | { 228 | return true; 229 | } 230 | 231 | /// 232 | public Task ChangePassword(User user, string newPassword) 233 | { 234 | throw new NotImplementedException(); 235 | } 236 | } 237 | } 238 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------