Removed GHE forms from ui folder

Fixed org/team field names based on @constreference feedback Added support for Github Enteprise for authentication
2026-01-11 01:57:35 -03:30 · 2020-02-27 11:45:38 +01:00 · 2020-02-27 11:45:38 +01:00 · 9ccee200f3
commit 9ccee200f3
parent 88cd154c97
4 changed files with 326 additions and 0 deletions
--- a/awx/settings/defaults.py
+++ b/awx/settings/defaults.py
@ -344,6 +344,9 @@ AUTHENTICATION_BACKENDS = (
    'social_core.backends.github.GithubOAuth2',
    'social_core.backends.github.GithubOrganizationOAuth2',
    'social_core.backends.github.GithubTeamOAuth2',
+    'social_core.backends.github_enterprise.GithubEnterpriseOAuth2',
+    'social_core.backends.github_enterprise.GithubEnterpriseOrganizationOAuth2',
+    'social_core.backends.github_enterprise.GithubEnterpriseTeamOAuth2',
    'social_core.backends.azuread.AzureADOAuth2',
    'awx.sso.backends.SAMLAuth',
    'django.contrib.auth.backends.ModelBackend',
@ -520,6 +523,20 @@ SOCIAL_AUTH_GITHUB_TEAM_SECRET = ''
 SOCIAL_AUTH_GITHUB_TEAM_ID = ''
 SOCIAL_AUTH_GITHUB_TEAM_SCOPE = ['user:email', 'read:org']

+SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_SCOPE = ['user:email', 'read:org']
+
+SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SCOPE = ['user:email', 'read:org']
+
+SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID = ''
+SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SCOPE = ['user:email', 'read:org']
+
 SOCIAL_AUTH_AZUREAD_OAUTH2_KEY = ''
 SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET = ''

--- a/awx/sso/conf.py
+++ b/awx/sso/conf.py
@ -842,6 +842,292 @@ register(
    placeholder=SOCIAL_AUTH_TEAM_MAP_PLACEHOLDER,
 )

+###############################################################################
+# GITHUB ENTERPRISE OAUTH2 AUTHENTICATION SETTINGS
+###############################################################################
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL',
+    field_class=fields.CharField,
+    read_only=True,
+    default=SocialAuthCallbackURL('github-enterprise'),
+    label=_('GitHub Enterprise OAuth2 Callback URL'),
+    help_text=_('Provide this URL as the callback URL for your application as part '
+                'of your registration process. Refer to the Ansible Tower '
+                'documentation for more detail.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise',
+    depends_on=['TOWER_URL_BASE'],
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_URL',
+    field_class=fields.CharField,
+    allow_blank=False,
+    default='',
+    label=_('GitHub Enterprise URL'),
+    help_text=_('The URL for your Github Enteprise.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL',
+    field_class=fields.CharField,
+    allow_blank=False,
+    default='',
+    label=_('GitHub Enterprise API URL'),
+    help_text=_('The API URL for your GitHub Enterprise.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise OAuth2 Key'),
+    help_text=_('The OAuth2 key (Client ID) from your GitHub Enterprise developer application.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub OAuth2 Secret'),
+    help_text=_('The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application.'),
+    category=_('GitHub OAuth2'),
+    category_slug='github-enterprise',
+    encrypted=True,
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP',
+    field_class=SocialOrganizationMapField,
+    allow_null=True,
+    default=None,
+    label=_('GitHub Enterprise OAuth2 Organization Map'),
+    help_text=SOCIAL_AUTH_ORGANIZATION_MAP_HELP_TEXT,
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise',
+    placeholder=SOCIAL_AUTH_ORGANIZATION_MAP_PLACEHOLDER,
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP',
+    field_class=SocialTeamMapField,
+    allow_null=True,
+    default=None,
+    label=_('GitHub Enterprise OAuth2 Team Map'),
+    help_text=SOCIAL_AUTH_TEAM_MAP_HELP_TEXT,
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise',
+    placeholder=SOCIAL_AUTH_TEAM_MAP_PLACEHOLDER,
+)
+
+###############################################################################
+# GITHUB ENTERPRISE ORG OAUTH2 AUTHENTICATION SETTINGS
+###############################################################################
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL',
+    field_class=fields.CharField,
+    read_only=True,
+    default=SocialAuthCallbackURL('github-enterprise-org'),
+    label=_('GitHub Enterprise Organization OAuth2 Callback URL'),
+    help_text=_('Provide this URL as the callback URL for your application as part '
+                'of your registration process. Refer to the Ansible Tower '
+                'documentation for more detail.'),
+    category=_('GitHub Enterprise Organization OAuth2'),
+    category_slug='github-enterprise-org',
+    depends_on=['TOWER_URL_BASE'],
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL',
+    field_class=fields.CharField,
+    allow_blank=False,
+    default='',
+    label=_('GitHub Enterprise URL'),
+    help_text=_('The URL for your Github Enteprise.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise-org',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL',
+    field_class=fields.CharField,
+    allow_blank=False,
+    default='',
+    label=_('GitHub Enterprise API URL'),
+    help_text=_('The API URL for your GitHub Enterprise.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise-org',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise Organization OAuth2 Key'),
+    help_text=_('The OAuth2 key (Client ID) from your GitHub Enterprise organization application.'),
+    category=_('GitHub Enterprise Organization OAuth2'),
+    category_slug='github-enterprise-org',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise Organization OAuth2 Secret'),
+    help_text=_('The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.'),
+    category=_('GitHub Enterprise Organization OAuth2'),
+    category_slug='github-enterprise-org',
+    encrypted=True,
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise Organization Name'),
+    help_text=_('The name of your GitHub Enterprise organization, as used in your '
+                'organization\'s URL: https://github.com/<yourorg>/.'),
+    category=_('GitHub Enterprise Organization OAuth2'),
+    category_slug='github-enterprise-org',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP',
+    field_class=SocialOrganizationMapField,
+    allow_null=True,
+    default=None,
+    label=_('GitHub Enterprise Organization OAuth2 Organization Map'),
+    help_text=SOCIAL_AUTH_ORGANIZATION_MAP_HELP_TEXT,
+    category=_('GitHub Enterprise Organization OAuth2'),
+    category_slug='github-enterprise-org',
+    placeholder=SOCIAL_AUTH_ORGANIZATION_MAP_PLACEHOLDER,
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP',
+    field_class=SocialTeamMapField,
+    allow_null=True,
+    default=None,
+    label=_('GitHub Enterprise Organization OAuth2 Team Map'),
+    help_text=SOCIAL_AUTH_TEAM_MAP_HELP_TEXT,
+    category=_('GitHub Enterprise Organization OAuth2'),
+    category_slug='github-enterprise-org',
+    placeholder=SOCIAL_AUTH_TEAM_MAP_PLACEHOLDER,
+)
+
+###############################################################################
+# GITHUB ENTERPRISE TEAM OAUTH2 AUTHENTICATION SETTINGS
+###############################################################################
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL',
+    field_class=fields.CharField,
+    read_only=True,
+    default=SocialAuthCallbackURL('github-enterprise-team'),
+    label=_('GitHub Enterprise Team OAuth2 Callback URL'),
+    help_text=_('Create an organization-owned application at '
+                'https://github.com/organizations/<yourorg>/settings/applications '
+                'and obtain an OAuth2 key (Client ID) and secret (Client Secret). '
+                'Provide this URL as the callback URL for your application.'),
+    category=_('GitHub Enterprise Team OAuth2'),
+    category_slug='github-enterprise-team',
+    depends_on=['TOWER_URL_BASE'],
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL',
+    field_class=fields.CharField,
+    allow_blank=False,
+    default='',
+    label=_('GitHub Enterprise URL'),
+    help_text=_('The URL for your Github Enteprise.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise-team',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL',
+    field_class=fields.CharField,
+    allow_blank=False,
+    default='',
+    label=_('GitHub Enterprise API URL'),
+    help_text=_('The API URL for your GitHub Enterprise.'),
+    category=_('GitHub Enterprise OAuth2'),
+    category_slug='github-enterprise-team',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise Team OAuth2 Key'),
+    help_text=_('The OAuth2 key (Client ID) from your GitHub Enterprise organization application.'),
+    category=_('GitHub Enterprise Team OAuth2'),
+    category_slug='github-enterprise-team',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise Team OAuth2 Secret'),
+    help_text=_('The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.'),
+    category=_('GitHub Enterprise Team OAuth2'),
+    category_slug='github-enterprise-team',
+    encrypted=True,
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID',
+    field_class=fields.CharField,
+    allow_blank=True,
+    default='',
+    label=_('GitHub Enterprise Team ID'),
+    help_text=_('Find the numeric team ID using the Github Enterprise API: '
+                'http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.'),
+    category=_('GitHub Enterprise Team OAuth2'),
+    category_slug='github-enterprise-team',
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP',
+    field_class=SocialOrganizationMapField,
+    allow_null=True,
+    default=None,
+    label=_('GitHub Enterprise Team OAuth2 Organization Map'),
+    help_text=SOCIAL_AUTH_ORGANIZATION_MAP_HELP_TEXT,
+    category=_('GitHub Enterprise Team OAuth2'),
+    category_slug='github-enterprise-team',
+    placeholder=SOCIAL_AUTH_ORGANIZATION_MAP_PLACEHOLDER,
+)
+
+register(
+    'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP',
+    field_class=SocialTeamMapField,
+    allow_null=True,
+    default=None,
+    label=_('GitHub Enterprise Team OAuth2 Team Map'),
+    help_text=SOCIAL_AUTH_TEAM_MAP_HELP_TEXT,
+    category=_('GitHub Enterprise Team OAuth2'),
+    category_slug='github-enterprise-team',
+    placeholder=SOCIAL_AUTH_TEAM_MAP_PLACEHOLDER,
+)
+
 ###############################################################################
 # MICROSOFT AZURE ACTIVE DIRECTORY SETTINGS
 ###############################################################################
--- a/awx/sso/fields.py
+++ b/awx/sso/fields.py
@ -187,6 +187,26 @@ class AuthenticationBackendsField(fields.StringListField):
            'SOCIAL_AUTH_GITHUB_TEAM_SECRET',
            'SOCIAL_AUTH_GITHUB_TEAM_ID',
        ]),
+        ('social_core.backends.github_enterprise.GithubEnterpriseOAuth2', [
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_URL',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET',
+        ]),
+        ('social_core.backends.github_enterprise.GithubEnterpriseOrganizationOAuth2', [
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME',
+        ]),
+        ('social_core.backends.github_enterprise.GithubEnterpriseTeamOAuth2', [
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET',
+            'SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID',
+        ]),
        ('social_core.backends.azuread.AzureADOAuth2', [
            'SOCIAL_AUTH_AZUREAD_OAUTH2_KEY',
            'SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET',
--- a/docs/auth/README.md
+++ b/docs/auth/README.md
@ -5,6 +5,9 @@ When a user wants to log into Tower, she can explicitly choose some of the suppo
 * Github OAuth2
 * Github Organization OAuth2
 * Github Team OAuth2
+* Github Enterprise OAuth2
+* Github Enterprise Organization OAuth2
+* Github Enterprise Team OAuth2
 * Microsoft Azure Active Directory (AD) OAuth2

 On the other hand, the other authentication methods use the same types of login info as Tower (username and password), but authenticate using external auth systems rather than Tower's own database. If some of these methods are enabled, Tower will try authenticating using the enabled methods *before Tower's own authentication method*. The order of precedence is: