config.default.js

/**
 * ===========================
 *        IEDON-PEERAPI       
 *        Configutation       
 * ===========================
 */

export default {
  listen: {
    type: 'unix', // 'tcp' or 'unix'
    hostname: 'localhost',
    port: 3000,
    path: '/var/run/peerapi.sock'
  },

  loggerSettings: {
    provider: 'log4js',
    log4js: {
      appenders: {
        stdout: {
          type: 'stdout'
        },
        app: {
          type: 'file',
          filename: './logs/app/app.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        },
        acorle: {
          type: 'file',
          filename: './logs/acorle/acorle.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        },
        mail: {
          type: 'file',
          filename: './logs/mail/mail.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        },
        whois: {
          type: 'file',
          filename: './logs/whois/whois.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        },
        fetch: {
          type: 'file',
          filename: './logs/fetch/fetch.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        },
        auth: {
          type: 'file',
          filename: './logs/auth/auth.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        },
        ssh: {
          type: 'file',
          filename: './logs/ssh/ssh.log',
          compress: true,
          backups: 7,
          maxLogSize: 10485760,
          keepFileExt: true
        }
      },
      categories: {
        default: {
          level: 'info',
          appenders: ['stdout']
        },
        app: {
          level: 'info',
          appenders: ['app']
        },
        acorle: {
          level: 'info',
          appenders: ['acorle']
        },
        database: {
          level: 'debug',
          appenders: ['stdout']
        },
        mail: {
          level: 'info',
          appenders: ['mail']
        },
        whois: {
          level: 'info',
          appenders: ['whois']
        },
        fetch: {
          level: 'info',
          appenders: ['fetch']
        },
        auth: {
          level: 'info',
          appenders: ['auth']
        },
        ssh: {
          level: 'info',
          appenders: ['ssh']
        }
      }
    }
  },

  // Integration with acorle microservice
  acorle: {
    enabled: false,
    zone: 'dev',
    secret: '',
    regIntervalSeconds: 30,
    centerServerUrl: 'http://',
    localUrl: 'http://',
    // To configure which configuration we will use, from center server via acorle, or configuration presented below
    retriveConfigFromCenterServer: true,
    configKey: 'peerapi_config',
    serviceKey: 'peerapi',
    serviceName: 'iEdon PeerAPI'
  },

  // ** The following configutations can be retrived via acorle **
  authHandler: {
    stateSignSecret: '__DEMO__STATE_SIGN_SECRET__',
    stateSignOptions: {
      algorithm: 'HS256',
      expiresIn: '10m'    // where sign-in state(via mail, pgp, ssh) expires
    },
    agentApiKey: '__DEMO__AGENT_API_TOKEN__', // PeerAPIConfig.secret in agent
  },

  sshAuthServerSettings: { // This app will starts a ssh server to accept connections to auth with us
    provider: 'default',
    challengeHint: 'ssh [-o "IdentitiesOnly=yes" -i ~/.ssh/id_rsa|ed25519] iedon.net -p 4222',
    ssh2: {
      listen: {
        type: 'tcp', // tcp or unix
        port: 4222,
        hostname: 'localhost',
        path: '/var/run/peerapi-ssh.sock' // unix domain socket
      },
      hostKeysPath: [
        '/etc/ssh/ssh_host_rsa_key'
      ],
      timeoutSeconds: 120,
      bannerText: [
        '==================================================',
        'Welcome to the IEDON-NET DN42 Auth Server!',
        'Kopiere den folgenden Herausforderungstext, um dich anzumelden.',
        'サインインするには、次のチャレンジテキストをコピーしてください。',
        '複製以下挑戰文本以登入。',
        '复制以下挑战文本以登录。',
        '==================================================',
      ]
    }
  },

  dbSettings: {
    dialect: 'mysql', /* sqlite */
    storage: '', /* for sqlite */
    host: 'localhost',
    port: 3306,
    user: '',
    password: '',
    database: 'iedon-peerapi',
    pool: {
      max: 5,
      min: 1,
      idle: 10000
    },
    logging: true,
    alter: false,        // set to true to alter database schema on startup
    dialectOptions: {}
  },

  redisSettings: {
    driver: {
      host: 'localhost',
      port: 6379,
      username: "default", // needs Redis >= 6
      password: '',
      db: 0,
      keyPrefix: 'peerapi:',
      maxRetriesPerRequest: 1,
      enableOfflineQueue: false
    }
  },

  mailSettings: {
    enableLoginByMail: false,
    provider: 'default',    // change to nodemailer to use smtp and fill configuration section bellow
    senderEmailAddress: 'dn42@localhost.localdomain',
    logging: true,
    limit: {
      maxEmailsPerDay: 500,
      maxEmailsPerHour: 100,
      maxEmailsPerMinute: 10
    },
    templateFile: './emailTemplate.html', // path to email template file
    nodemailer: {
      host: 'smtp.localhost.localdomain',
      port: 465,
      secure: true,
      auth: {
        user: '',
        pass: ''
      }
    },
    acorle: {                           // configuration for acorle mail provider(via microservice)
      serviceKey: 'dn42_send_mail'      // service key for RPC
    }
  },

  whoisSettings: {
    provider: 'default',    // default provider is using whois package and takes whois configuration section bellow
    logging: true,
    whois: {
      server: 'whois.dn42',        // this can be a string ("host:port") or an object with host and port as its keys; leaving it empty makes lookup rely on servers.json
      follow: 2,         // number of times to follow redirects
      timeout: 10000,         // socket timeout, excluding this doesn't override any default timeout value
      verbose: false,     // setting this to true returns an array of responses from all servers
      bind: null,         // bind the socket to a local IP address
      // proxy: {            // (optional) SOCKS Proxy
      //     host: "",
      //     port: 0,
      //     type: 5         // or 4
      // }
    },
    acorle: {               // configuration for acorle whois provider(via microservice)
      serviceKey: 'dn42_whois'      // service key for RPC
    }
  },

  fetchSettings: {
    provider: 'default',    // default provider is using urllib package and takes fetch configuration section bellow
    logging: true,
    fetch: {
      options: {
        timeout: 10000,
        cache: 'no-cache',
        headers: {
          'User-Agent': 'iEdon-PeerAPI'
        },
      }
    },
  },

  openAuthSettings: {
    providers: [ 'kioubit', 'default' ],
    kioubit: {
      myDomain: 'iedon.net',
      notAllowed: [ 4242422189 ],
      publicKey: './kioubitAuth.pem'
    },
  },

  tokenSettings: {
    provider: 'default',    // default provider is using jsonwebtoken package and takes jwt configuration section bellow
    logging: true,
    jwt: {
      secret: '__DEMO_SECRET_IEDON_PEERAPI__',
      options: {
        algorithm: 'HS256',
        expiresIn: '5m'
      }
    },
    acorle: {               // configuration for acorle auth provider(via microservice)
      serviceKey: 'dn42_token'      // service key for RPC
    }
  },

  metricSettings: {
    maxRecordsToKeep: 288, // 288 records = 24 hours with 5 minutes interval
    redisLockTimeoutMs: 10000, // 10 seconds
    exporter: {
      scannerBatchSize: 200, // number of keys to scan in one batch when exporting metrics
      allowedBasicAuthUsers: [ // Recommended HTTPS endpoint
        {
          username: 'admin',
          password: 'admin'
        }
      ]
    }
  },

  probeServerSettings: {
    enabled: true,
    sessionHealthyTimeoutSec: 300, // 5min, if no data received in this time, session is considered unhealthy
    bindUdpPort: 2189,
    bindAddress4: '0.0.0.0',
    bindAddress6: '::',
    encryptionKey: '___DEMO__PROBE_32_PACKET__KEY___',
    expectedBanner: 'iEdon-Net PeerAPI Peering Prober',
    maxPacketLength: 512,
    timestampToleranceSec: 120, // Anti replay tolerance for packet timestamp
  },

  // Configure CORS, preflight headers and custom headers here
  preflightHeaders: {
    'Access-Control-Request-Method': 'POST',
    'Access-Control-Request-Headers': 'X-PINGOTHER, Content-Type',
    'Access-Control-Allow-Methods': 'POST, OPTIONS',
    'Access-Control-Max-Age': '86400'
  },

  corsHeaders: {
    'Access-Control-Allow-Origin': '*',
    'Access-Control-Allow-Headers': 'X-PeerAPI-Version, Content-Type, Authorization'
  },

  customHeaders: {
    'X-Powered-By': 'PHP/8.4.11'
  }
}