VectorProof documentation
Version 1.0.0. The image reference and product SKU appear in AWS Marketplace after you subscribe.
Downloads: CloudFormation template and Helm chart.
Requirements
- An active AWS Marketplace contract with at least one Installation unit. Add AssessmentCredit units to run full assessments.
- Amazon RDS for PostgreSQL 17. The CloudFormation template creates it.
- An ACM certificate for your hostname.
- Written authorization to test each application you add.
Deploy on Amazon ECS
aws cloudformation deploy --template-file vectorproof-ecs.yaml \ --stack-name vectorproof --capabilities CAPABILITY_IAM \ --parameter-overrides ImageUri=IMAGE_URI ProductSku=PRODUCT_SKU \ AppUrl=https://vectorproof.example.com TargetAllowedHosts=rag.example.com \ VpcId=vpc-xxxx PrivateSubnets=subnet-a,subnet-b PublicSubnets=subnet-c,subnet-d \ CertificateArn=arn:aws:acm:REGION:ACCOUNT:certificate/ID AllowedIngressCidr=10.0.0.0/8
Point your hostname at the LoadBalancerDns output. Migrations run before the API starts. To evaluate without your own application, set EnableDemoTargets=true. That adds simulated vulnerable and hardened applications at http://127.0.0.1:9191 and :9192 in the worker task, with logins Bearer demo-owner, demo-denied and demo-other. Turn this off for production.
Deploy on Amazon EKS
Create an IAM role for service accounts with the permissions below. Create two Kubernetes Secrets. Generate each key with openssl rand -hex 32.
- vectorproof-migration: DB_HOST, DB_NAME, DB_USER, DB_PASSWORD, DB_ADMIN_USER, DB_ADMIN_PASSWORD
- vectorproof-runtime: DB_HOST, DB_NAME, DB_USER, DB_PASSWORD, ENCRYPTION_KEY, SESSION_KEY, BOOTSTRAP_SECRET
Edit values.yaml: image.registry, image.repository, image.tag, appUrl, targetAllowedHosts, productSku, awsRegion, runtimeSecretName, migrationSecretName, serviceAccount.name, serviceAccount.roleArn, apiReplicas, workerReplicas, resources and ingress. For another AWS Region, change image.registry.
helm install vectorproof ./vectorproof -f values.yaml
First sign-in
aws secretsmanager get-secret-value --secret-id BOOTSTRAP_SECRET_ARN --query SecretString --output text
Open your AppUrl and enter your organization, your email and that secret, which works once. Save the owner access token shown, because it appears only once. For single sign-on, set OIDC_ISSUER, OIDC_CLIENT_ID and OIDC_CLIENT_SECRET, with the callback AppUrl/auth/oidc/callback, and add each user under Users.
First scan
- Add a target. Its host must be in TARGET_ALLOWED_HOSTS. Provide owner, denied and optionally other_tenant identities, then confirm you are authorized to test it.
- A full assessment uses one AssessmentCredit after the target passes preflight. CI quick uses none.
- Active mode adds and removes temporary test documents, and your fixture endpoint must apply the supplied tenant and allowed_identities to each one. Passive mode only sends queries.
- Review each result and its evidence timeline, then download HTML or JSON reports.
CI/CD
docker run --rm -e VECTORPROOF_URL -e VECTORPROOF_TOKEN IMAGE_URI scan \ --target TARGET_ID --campaign ci-quick --mode passive --fail-on high --min-coverage 50
Exit codes: 0 passed, 1 scan could not complete, 2 findings at or above --fail-on, 3 coverage below --min-coverage.
IAM permissions
Required on the task or pod role: license-manager:CheckoutLicense, GetLicense, CheckInLicense, ExtendLicenseConsumption and ListReceivedLicenses. Optional for Bedrock targets and S3 test documents: bedrock:InvokeModel, Retrieve, RetrieveAndGenerate, StartIngestionJob, and s3:PutObject, PutObjectTagging, DeleteObject. The product never asks for AWS credentials.
Licensing
One installation uses one Installation unit, whatever its replica count. The check repeats every 15 minutes. If AWS License Manager is briefly unreachable after a successful check, scans continue for up to 2 hours. If no unit is available, sign-in, findings, reports and cleanup still work and new scans are blocked.
Data and encryption
- Target credentials: AES-256-GCM in the PostgreSQL targets table, using ENCRYPTION_KEY.
- Access tokens: stored only as SHA-256 hashes.
- Evidence: stored in PostgreSQL after pattern-based redaction. Review reports before sharing them.
- Keys and database logins: AWS Secrets Manager on ECS, or your Kubernetes Secrets on EKS.
- The CloudFormation template encrypts RDS at rest and uses TLS at the load balancer.
Rotating keys
Rotate ENCRYPTION_KEY at least yearly. Set the new value as ENCRYPTION_KEY and the old value as ENCRYPTION_KEY_PREVIOUS, run the container with the rotate-key command, then remove ENCRYPTION_KEY_PREVIOUS. Rotating SESSION_KEY signs everyone out. Revoke access tokens in the console.
Backup and recovery
The template enables 14 days of RDS automated backups, Multi-AZ, deletion protection and a final snapshot. To recover, restore a snapshot to a new instance and update DB_HOST. Keep ENCRYPTION_KEY with your backups: without it, stored target credentials cannot be decrypted, though findings stay readable.
Health
GET /healthz shows the process is up. GET /readyz checks the database and reports license status. Logs are in CloudWatch Logs under /vectorproof/STACK_NAME. Check that each ECS service has one running task and that scans leave the queued state.
Quotas and costs
The template needs one load balancer, one RDS instance, two Fargate services and five Secrets Manager secrets, which fit default quotas in most accounts. You pay AWS separately for these and for any Amazon Bedrock usage your tests cause. Use the AWS Pricing Calculator to estimate them.
Upgrades
Back up the database, then update the stack with the new ImageUri. On EKS, update image.tag and run helm upgrade. Migrations run automatically. Keep the same ENCRYPTION_KEY.