cerberus.yaml

logging.level:
  com.nike.cerberus.metrics.LoggingMetricsService: INFO
  VALID_WINGTIPS_SPANS: WARN

management:
  endpoints:
    enabledByDefault: false
    web:
      basePath: /
      pathMapping.health: healthcheck
  endpoint:
    info.enabled: true
    health.enabled: true

mybatis:
  mapper-locations: classpath:com/nike/cerberus/mapper/*Mapper.xml
  type-aliases-package: com.nike.cerberus.record
  environment:
    id: prod
  configuration:
    mapUnderscoreToCamelCase: true

flyway:
  schemas: cms
  locations: classpath:com/nike/cerberus/migration

# Configure the mysql settings here
jdbc:
  driver: com.mysql.jdbc.Driver
  url: jdbc:mysql://localhost:3306/cms?useUnicode=true&characterEncoding=utf8&useLegacyDatetimeCode=false&serverTimezone=UTC&useSSL=false
#  username: encrypted:secrets-manager!r:some-region!s:some-secret!k:some-key
#  password: encrypted:secrets-manager!r:some-region!s:some-secret!k:some-key

c3p0:
  initialPoolSize: 80
  minPoolSize: 80
  maxPoolSize: 400
  acquireIncrement: 10
  checkoutTimeout: 30000
  testConnectionOnCheckin: true
  idleConnectionTestPeriod: 300
  maxIdleTimeExcessConnections: 4200
  maxConnectionAge: 300
  preferredTestQuery: SELECT 1

cerberus:
  partitions:
    awsGlobal:
      enabled: true
    awsChina:
      enabled: false
  environmentName: TODO
  admin:
    # These are aws principal that you want to allow to use the admin API
    roles: ~
    # The user group that the Cerberus operators belong to, this unlocks admin API perms
    group: ~

  encryption:
    # comma delimited list of the CMKs for a KMS key that the iam role that Cerberus runs as has access to.
    # These are normally generated by the lifecycle cli, you should have at least 2 from 2 different regions
    cmk.arns: ~
    # Data Key Caching for the SDK Crypto Client
    # Why you would want to enable this:
    # KMS has an account wide API limit for KMS of 1200 RPS.
    # Cerberus uses KMS to encrypt and decrypt its data, and by default will make an API call to KMS at least 1 per request.
    # Enabling this cache will allow CMS to to skip calls to KMS for repeat reads of the same data.
    cache:
      enabled: false
      encrypt:
        maxSize: 1000
        maxAgeInSeconds: 60
        messageUseLimit: 100
      decrypt:
        maxSize: 1000
        maxAgeInSeconds: 60


  # MyBaits Caching
  # CMS uses mybatis as its ORM for the mysql data store.
  # Enabling this cache will cause CMS to cache certain repeat reads that exceed a configurable threshold from various mappers (Some mappers excluded, Lock mapper for example) for some TTL.
  # This will protect the DB from high bursts of repeat reads at the cost of potentially making some of its data eventually consistent.
  # Ex: if a secret / property has been cached it will remain there for upto the whole TTL after a new value has been written.
  # This cache is not distributed and will be in mem on each instance of CMS.
  #
  # The way the repeat read threshold works is as follows
  #
  # Assume the default settings of dataTtlInSeconds=10, repeatReadCounterResetInSeconds=2, repeatReadThreshold=2
  # Every time a read occurs on a individual instance of CMS a counter is incremented.
  # Every time a fetch from the DB occurs MyBatis calls put on the cache object.
  # When the put call happens we check to see if the count has exceeded the repeatReadThreshold threshold, if so cache it for the dataTtlInSeconds ttl, if not don't cache.
  # If there hasn't been any reads in repeatReadCounterResetInSeconds seconds the counter is reset.
  mybatis.cache:
    enabled: false
    global:
      # Override the global TTL for items after write here, defaults to 10.
      dataTtlInSeconds: 10
      # Override the the global Repeat Read counter reset interval here
      repeatReadCounterResetInSeconds: 2
      # Override the global repeat read count threshold here
      repeatReadThreshold: 2
    # All of the global settings can be overridden for any mapper in resources/com/nike/cerberus/mapper.
    # EX: src/main/resources/com/nike/cerberus/mapper/CategoryMapper.xml -> categoryMapper
    # Use camelCase for the mapper name
#    categoryMapper:
#      dataTtlInSeconds: 10
#      repeatReadCounterResetInSeconds: 2
#      repeatReadThreshold: 2

  # Settings for the generation of auth tokens, these are the tokens that are issued to
  # principals and are used to interact with the API
  auth.token:
    generate.length: 64
    hash:
      iterations: 100
      keyLength: 256
      algorithm: PBKDF2WithHmacSHA512
      # This is the salt to use in the hashing algo, normally generated by the lifecycle cli
#      salt: encrypted:secrets-manager!r:some-region!s:some-secret!k:some-key

  auth.iam:
    token.ttl: 1h

  auth.user:
    # Toggles whether or not user groups are case sensitive in your Auth Connector impl.
    groups.caseSensitive: true
    token:
      maxRefreshCount: 0 # How often User Principals are allowed to refresh their auth token
      ttl: 1h # How long user tokens are valid for.
    # You can configure which User Authentication Connector to use here, you must enable one and only one.
    connector:
      okta:
        enabled: false
#        apiKey: yourApiKey
#        baseUrl: yourOktaBaseUrl
      oneLogin:
        enabled: false
#        clientId: yourClientId
#        clientSecret: yourClientSecret
#        subdomain: yourSubDomain


  # With Cerberus 4.+ (Phoenix) We now have officially deprecated and turned off by default KMS Auth
  # This was the original way of doing IAM authentication, its complicated, requires Cerberus to run in it's own account
  # or in an account were you trust everyone who can create IAM roles and kms key policies.
  # It also requires Cerberus users to have a special IAM policy in order to auth.
  # STS Auth, is much better and has been made possible by new AWS APIs that have been released since Cerberus was created.
  # See: https://engineering.nike.com/cerberus/docs/authentication/aws-iam-sts-authentication#why
  # Also See
  # https://engineering.nike.com/cerberus/docs/authentication/aws-iam-kms-authentication
  # https://engineering.nike.com/cerberus/docs/authentication/aws-iam-sts-authentication
  auth.iam.kms:
    enabled: false
    # This should be the root user for the account that this service will be ran in, so that KMS keys can be managed by that user
    rootUserArn: ~
    # This should be some sort of role that your team can assume, its ok to re-use the cms role arn here. This will be used when creating the kms keys for kms auth to allow your team to manage them
    adminRoleArn: ~
    # This should be the role that this service will have as its instance profile when running, this will be used when creating the kms keys for kms auth to allow cerberus to manage them
    cmsRoleArn: ~
    # When an IAM Principal is deleted externally this makes the KMS key policy invalid, this controls how often Cerberus should check that a policy is valid and attempt to fix it.
    policy.validation.interval.millis: 300000

    # Enable caching the generated encrypted AWS IAM KMS Auth object, so that burst authentication of the same
    # principal does not result in repeat KMS encrypt calls
    # Why you would want to enable this:
    # KMS has an account wide API limit for KMS of 1200 RPS.
    # Cerberus uses KMS to encrypt the auth payload, and by default will make an API call to KMS at least 1 per request.
    # Enabling this cache will allow CMS to to skip calls to KMS for repeat authenticates of the same IAM principal.
    cache:
      enabled: false
      maxAgeInSeconds: 10

  metricsService:
    # If you do not supply your own impl of com.nike.cerberus.metrics.MetricsService on the classpath then the LoggingMetricsService is used.
    # You can configure what log level and how frequently to log custom metrics at here. Feel free to contribute a generic impl!
    loggingMetricsService:
      level: INFO
      period: 1
      timeUnit: MINUTES

  # If you have used the life cycle CLI to generate the S3 bucket and Athena table you can use this engine to have a
  # robust audit system that supports sql lookups on SDBs, IP Addresses and principals, etc.
  audit.athena:
      enabled: false
      #  bucket: yourS3Bucket
      #  bucketRegion: yourBucketRegion

  # The default audit engine, logs audit events using an regular slf4j logger that goes to the stdout.
  audit.logger:
      enabled: true

  # With Cerberus 4.+ (Phoenix) We now have officially deprecated and turned off by default some endpoints we plan on deleting.
  deprecatedEndpoints:
    # This has been deprecated for a long time, and we are now turning it off by default so we can delete it soon.
    # /v1/safe-deposit-box
    safeDepositBox.v1.enabled: false

  jobs:
    initialDelay: 0
    initialDelayTimeUnits: minutes

    # Ensures that the KMS datakeys that are used to encrypt data get rotated and that secrets are decrypted
    # and re-encrypted with new data-key
    dataKeyRotationJob:
      enabled: true
      numberOfDataKeyToRotatePerJobRun: 120
      dataKeyRotationPauseTimeInMillis: 1000
      dataKeyRotationIntervalInDays: 90
      # Every hour
      cronExpression: "0 0 * ? * *"

    # Removes expired auth tokens from the database
    expiredTokenCleanUpJob:
      enabled: true
      maxNumberOfTokensToDeletePerJobRun: 2500
      numberOfTokensToDeletePerBatch: 1000
      batchPauseTimeInMillis: 0
      # Every ten minutes
      cronExpression: "0 */10 * ? * *"

    # Generates drop wizard metrics on the status of Hystrix for monitoring and alerting
    hystrixMetricsProcessingJob:
      enabled: true
      # Every ten seconds
      cronExpression: "0/10 * * ? * *"

    # This job will generate Key Performance Indicator Metrics (KPIs) for the Cerberus environment and use Drop Wizard to report these Metrics
    # By default unless you provide your own reporter impl, these metrics are just logged via an SLF4j Logger.
    # Types of metrics that it generates: numberOfUniqueIamRoles, numberOfUniqueOwnerGroups, numberOfUniqueNonOwnerGroups, totalUniqueUserGroups, etc
    kpiMetricsProcessingJob:
      enabled: true
      # Every hour
      cronExpression: "0 0 * ? * *"


    ################################################################################################
    # This Job require auth.iam.kms.rootUserArn,adminRoleArn,cmsRoleArn to be configured
    # This job is now disabled by default since kms auth is disabled by default
    #################################################################################################
    # When a principal uses the legacy KMS authentication, a KMS key is lazily created for it. This job will
    # delete keys that have become in-active, this job is safe as if the principal authenticates again a new key will be lazily created.
    inactiveKmsCleanUpJob:
      enabled: false
      batchPauseTimeInSeconds: 10
      deleteKmsKeysOlderThanNDays: 30
      # Every day at noon
      cronExpression: "0 0 12 * * ?"

    ################################################################################################
    # This Job require auth.iam.kms.rootUserArn,adminRoleArn,cmsRoleArn to be configured
    # This job is now disabled by default since kms auth is disabled by default
    #################################################################################################
    # Deletes orphaned KMS keys, when an principal that has authenticated with Cerberus has been deleted and is
    # no longer associated with any SDB any keys that were created for it become orphaned.
    # This job will clean those up
    orphanedKmsKeyCleanUpJob:
      enabled: false
      dryMode: false
      # Every 15 days at noon
      cronExpression: "0 0 12 */15 * ?"

# Don't forget to enable SSL so your traffic is encrypted end to end
#security.requireSsl: true
#server.ssl:
#  keyStore: encryptedFile:secrets-manager!r:some-region!s:some-secret
#  keyStorePassword: encrypted:secrets-manager!r:some-region!s:some-secret!k:some-key