Skip to content

Update Okta Module to use Models #1243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Okta Module to use Models #1243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 48 additions & 32 deletions cartography/intel/okta/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
import logging
import asyncio
from typing import Dict

import neo4j
from okta.framework.OktaError import OktaError
from okta.client import Client as OktaClient

from cartography.config import Config

from cartography.intel.okta import applications

from cartography.intel.okta import awssaml
from cartography.intel.okta import factors
from cartography.intel.okta import authenticators
from cartography.intel.okta import groups
from cartography.intel.okta import organization

from cartography.intel.okta import origins
from cartography.intel.okta import roles

from cartography.intel.okta import users
from cartography.intel.okta.sync_state import OktaSyncState
from cartography.stats import get_stats_client
from cartography.util import merge_module_sync_metadata
from cartography.util import run_cleanup_job
Expand All @@ -24,19 +27,36 @@


@timeit
def _cleanup_okta_organizations(neo4j_session: neo4j.Session, common_job_parameters: Dict) -> None:
def _cleanup_okta_organizations(
neo4j_session: neo4j.Session, common_job_parameters: Dict
) -> None:
"""
Remove stale Okta organization
:param neo4j_session: The Neo4j session
:param common_job_parameters: Parameters to carry to the cleanup job
:return: Nothing
"""
run_cleanup_job('okta_import_cleanup.json', neo4j_session, common_job_parameters)
run_cleanup_job("okta_import_cleanup.json", neo4j_session, common_job_parameters)
cleanup_okta_groups(neo4j_session, common_job_parameters)


def cleanup_okta_groups(neo4j_session: neo4j.Session, common_job_parameters: Dict) -> None:
run_cleanup_job('okta_groups_cleanup.json', neo4j_session, common_job_parameters)
def cleanup_okta_groups(
neo4j_session: neo4j.Session, common_job_parameters: Dict
) -> None:
run_cleanup_job("okta_groups_cleanup.json", neo4j_session, common_job_parameters)


def _create_okta_client(okta_domain: str, okta_api_key: str) -> OktaClient:
"""
Create Okta User Client
:param okta_domain: Okta domain
:param okta_api_key: Okta API key
:return: Instance of UsersClient
"""
config = {"orgUrl": f"https://{okta_domain}/", "token": okta_api_key}
okta_client = OktaClient(config)

return okta_client


@timeit
Expand All @@ -60,36 +80,32 @@ def start_okta_ingestion(neo4j_session: neo4j.Session, config: Config) -> None:
"OKTA_ORG_ID": config.okta_org_id,
}

state = OktaSyncState()

organization.create_okta_organization(neo4j_session, config.okta_org_id, config.update_tag)
users.sync_okta_users(neo4j_session, config.okta_org_id, config.update_tag, config.okta_api_key, state)
groups.sync_okta_groups(neo4j_session, config.okta_org_id, config.update_tag, config.okta_api_key, state)
applications.sync_okta_applications(neo4j_session, config.okta_org_id, config.update_tag, config.okta_api_key)
factors.sync_users_factors(neo4j_session, config.okta_org_id, config.update_tag, config.okta_api_key, state)
origins.sync_trusted_origins(neo4j_session, config.okta_org_id, config.update_tag, config.okta_api_key)
awssaml.sync_okta_aws_saml(neo4j_session, config.okta_saml_role_regex, config.update_tag)

# need creds with permission
# soft fail as some won't be able to get such high priv token
# when we get the E0000006 error
# see https://developer.okta.com/docs/reference/error-codes/
try:
roles.sync_roles(neo4j_session, config.okta_org_id, config.update_tag, config.okta_api_key, state)
except OktaError as okta_error:
logger.warning(f"Unable to pull admin roles got {okta_error}")

# Getting roles requires super admin which most won't be able to get easily
if okta_error.error_code == "E0000006":
logger.warning("Unable to sync admin roles - api token needs admin rights to pull admin roles data")
okta_client = _create_okta_client(config.okta_org_id, config.okta_api_key)

organization.sync_okta_organization(neo4j_session, common_job_parameters)
users.sync_okta_users(okta_client, neo4j_session, common_job_parameters)
groups.sync_okta_groups(okta_client, neo4j_session, common_job_parameters)
users.sync_okta_user_types(okta_client, neo4j_session, common_job_parameters)
applications.sync_okta_applications(
okta_client, neo4j_session, common_job_parameters
)
origins.sync_okta_origins(okta_client, neo4j_session, common_job_parameters)
authenticators.sync_okta_authenticators(
okta_client, neo4j_session, common_job_parameters
)

# TODO: Deprecate this while we determine a method of making it more generic
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker: This is still needed.

# awssaml.sync_okta_aws_saml(
# neo4j_session, config.okta_saml_role_regex, config.update_tag
# )

_cleanup_okta_organizations(neo4j_session, common_job_parameters)

merge_module_sync_metadata(
neo4j_session,
group_type='OktaOrganization',
group_type="OktaOrganization",
group_id=config.okta_org_id,
synced_type='OktaOrganization',
synced_type="OktaOrganization",
update_tag=config.update_tag,
stat_handler=stat_handler,
)
Loading