Cosmos Server

SmartShield is an API protection package that implements advanced rate-limiting and user restrictions to secure your APIs.

Key features include:

• Dynamic Rate Limiting: Calculates limits based on user behavior.
• Adaptive Actions: Automatically throttles users exceeding limits.
• User Bans & Strikes: Automatically issues strikes or bans to prevent abuse.
• Global Request Control: Limits total simultaneous requests via queues.
• User-based Metrics: Tracks requests, data usage, and simultaneous connections per user.
• Privileged Access: Allows specific user groups to bypass certain restrictions.
• Customizable Policies: Allows modification of request limits and time budgets.

To add the Cosmos Server Go SDK to your Go project, use the go get command.

go get github.com/azukaar/cosmos-server/go-sdk

Cosmos Server can automatically generate and renew HTTPS certificates using Let's Encrypt. It supports wildcard certificates via the DNS challenge.

To enable this:

1. Add a DNSChallengeProvider to the HTTPConfig in your configuration or via the UI.
2. Provide the required API token via environment variables.

Supported providers and their required environment variables can be found in the lego dns providers documentation.

Self-hosted application developers can integrate with Cosmos to leverage built-in security and management features. Integration provides:

• Secure Authentication: A robust system for handling passwords, encryption, and tokens.
• HTTP Layer Protection: Robust protection for your application's web interface.
• HTTPS Support: Automatic certificate management.
• User Management & Encryption: Centralized control over users and data.
• Logging & Backup: Integrated system monitoring and data protection.

Applications that do not integrate with Cosmos will still function normally, but will not benefit from these integrated security features.

After running the Docker command, access the web interface to complete the installation:

1. Navigate to http://your-server-ip in your browser.
2. Crucial: Always use your browser in incognito mode for the initial setup to prevent issues with browser cache.
3. Follow the on-screen instructions provided by the setup wizard.

Install the JavaScript/TypeScript SDK for the Cosmos Server API using npm.

npm install cosmos-cloud-sdk

You can install the Cosmos provider using terraform init, which automatically downloads the provider for your platform. Alternatively, you can perform a manual installation by downloading the binary from GitHub Releases and placing it in the following directory structure:

~/.terraform.d/plugins/cosmos-cloud.io/azukaar/cosmos/<VERSION>/<OS>_<ARCH>/

terraform {
  required_providers {
    cosmos = {
      source = "cosmos-cloud.io/azukaar/cosmos"
    }
  }
}

Cosmos provides several ways to interact with the API programmatically and automate infrastructure:

• JavaScript/TypeScript SDK: For programmatic access to the Cosmos API. See the JS SDK documentation for installation and usage.
• Go SDK: Available in the go-sdk folder. See the Go SDK documentation.
• Terraform Provider: Use the Terraform documentation to fully automate your Cosmos setup.

To compile and install the provider locally, use the provided Makefile commands. After installation, you must remove your existing lock file and re-initialize Terraform to use the local version.

1. Compile and install: make build make install

2. Update your Terraform project: rm .terraform.lock.hcl && terraform init

cd terraform-provider-cosmos
make build    # compile
make install  # copy to ~/.terraform.d/plugins/

# In your terraform project:
rm .terraform.lock.hcl && terraform init

To iterate quickly without running terraform init every time, configure a dev_overrides in your ~/.terraformrc file. This tells Terraform to use your local build directory directly.

1. Add the following to ~/.terraformrc:

provider_installation {
  dev_overrides {
    "cosmos-cloud.io/azukaar/cosmos" = "/path/to/terraform-provider-cosmos"
  }
  direct {}
}

2. Run make build and then terraform plan directly.