Skip to content

Latest commit

 

History

History
106 lines (77 loc) · 4.32 KB

README.md

File metadata and controls

106 lines (77 loc) · 4.32 KB
Raw

baton-sql-server

baton-sql-server is a connector for Microsoft SQL Server. It communicates with the SQL Server to sync data about users, groups, server roles, databases, and database roles.

It uses go-mssqldb to connect to SQL Server. Check out https://github.com/microsoft/go-mssqldb#connection-parameters-and-dsn for more details on how to connect to your server.

Check out Baton to learn more the project in general.

Getting Started

This connector requires that you connect to your SQL Server instance with a user with the proper access to read the system tables. The following permissions are required:

  • VIEW ANY DEFINITION on the server
  • VIEW ANY DATABASE on the server
  • VIEW ANY DEFINITION on each database
  • VIEW SERVER STATE on the server
  • VIEW DATABASE STATE on each database

The following tables are read while syncing data with this connector:

  • sys.server_principals
  • sys.databases
  • sys.server_permissions
  • sys.server_role_members
  • sys.database_principals on each database
  • sys.database_role_members on each database

brew

brew install conductorone/baton/baton conductorone/baton/baton-sql-server
baton-sql-server --dsn "server=127.0.0.1;user id=sa;password=devP@ssw0rd;port=1433" 
baton resources

docker

docker run --rm -v $(pwd):/out -e BATON_DSN="server=127.0.0.1;user id=sa;password=devP@ssw0rd;port=1433" ghcr.io/conductorone/baton-sql-server:latest -f "/out/sync.c1z"
docker run --rm -v $(pwd):/out ghcr.io/conductorone/baton:latest -f "/out/sync.c1z" resources

source

go install github.com/conductorone/baton/cmd/baton@main
go install github.com/conductorone/baton-sql-server/cmd/baton-sql-server@main
baton-sql-server --dsn "server=127.0.0.1;user id=sa;password=devP@ssw0rd;port=1433" 
baton resources

Data Model

baton-sql-server syncs information about the following resources:

  • Users
  • Groups
  • Server Roles
  • Databases
  • Database Roles

When fetching database permissions, the server principal backing the database principal will the resource that is granted entitlements.

Development

A docker compose file is included to easily spin up a SQL Server instance for development. To start the instance, run:

docker-compose up -d

The instance will be available at localhost:1433. The default username is sa and the default password is devP@ssw0rd.

Contributing, Support, and Issues

We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small -- our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, problems, or ideas: Please open a Github Issue!

See CONTRIBUTING.md for more details.

baton-sql-server Command Line Usage

baton-sql-server

Usage:
  baton-sql-server [flags]
  baton-sql-server [command]

Available Commands:
  capabilities       Get connector capabilities
  completion         Generate the autocompletion script for the specified shell
  help               Help about any command

Flags:
      --client-id string       The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
      --client-secret string   The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
      --dsn string             The connection string for connecting to SQL Server ($BATON_DSN)
  -f, --file string            The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
  -h, --help                   help for baton-sql-server
      --log-format string      The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
      --log-level string       The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
  -p, --provisioning           This must be set in order for provisioning actions to be enabled ($BATON_PROVISIONING)
  --skip-unavailable-databases   Skip databases that are unavailable (offline, restoring, etc) ($BATON_SKIP_UNAVAILABLE_DATABASES)
      --ticketing              This must be set to enable ticketing support ($BATON_TICKETING)
  -v, --version                version for baton-sql-server

Use "baton-sql-server [command] --help" for more information about a command.