index.md

Building a secrets store in Go

Index

• Concept
• Design
  • App structure
  • Error handling
  • Entities
    • User
    • Secret
    • Shared
  • Database Design
    • users table
    • secrets table
    • shared table
  • Actions and operations
  • Security
  • Product Format
• Implementation
  • The user package
    • user.go - defining entities
    • repository.go - defining the actions
    • Users recap
  • The secret package
    • secret.go - defining entities
    • repository.go - defining the actions
    • Secrets recap
  • The shared package
    • shared.go - defining entities
    • repository.go - defining the actions
    • Shared recap
  • The keys package
    • key.go - defining constants and identifiers
    • repository.go - defining the actions
    • Keys recap
  • Bolt DB implementation
    • Initializing a Bolt DB instance
    • Implementing keysRepository.Get
    • Implementing keysRepository.Set
    • Implementing keysRepository.Delete and keysRepository.Purge
    • Defining errors and updating imports
    • BoltDB recap
  • SQLite implementation
    • Defining the initial migration
    • Initializing a SQLite DB instance
    • Defining helper functions
      • SQL Querier types
      • SQL-type converters
      • IsEntityFound functions
    • Implementing user.Repository
      • Implementing userRepository.Create
      • Implementing userRepository.Get
      • Implementing userRepository.List
      • Implementing userRepository.Update
      • Implementing userRepository.Delete
      • Defining errors and updating imports
    • Implementing secret.Repository
      • Implementing secretRepository.Create
      • Implementing secretRepository.Get
      • Implementing secretRepository.List
      • Implementing secretRepository.Delete
      • Defining errors and updating imports
    • Implementing shared.Repository
      • Implementing sharedRepository.Create
      • Implementing sharedRepository.Get
      • Implementing sharedRepository.List
      • Implementing sharedRepository.ListTarget
      • Implementing sharedRepository.Delete
      • Defining errors and updating imports
    • Service preparation
      • Cryptography
        • Key generating methods
      • Authorization
    • Service implementation
      • Implementing Service Users methods
        • service.CreateUser
        • service.GetUser
        • service.ListUsers
        • service.UpdateUser
        • service.DeleteUser
      • Implementing Service Secrets methods
        • service.CreateSecret
        • service.GetSecret
        • service.ListSecrets
        • service.DeleteSecret
      • Implementing Service Shares methods
        • service.CreateShare / ShareFor / ShareUntil
        • service.GetShare
        • service.ListShares
        • service.DeleteShare
        • service.PurgeShares
      • Implementing Service Sessions methods
        • service.Login
        • service.Logout
        • service.ChangePassword
        • service.Refresh
        • service.ParseToken
    • HTTP API implementation
      • Peek into ghttp
      • Designing the endpoints
      • HTTP helpers
      • Defining the server
        • server.usersGet
        • server.usersList
        • server.usersUpdate
        • server.usersDelete
        • server.secretsCreate
        • server.secretsGet
        • server.secretsList
        • server.secretsDelete
        • server.sharesCreate
        • server.sharesGet
        • server.sharesList
        • server.sharesDelete
        • server.login
        • server.logout
        • server.changePassword
        • server.refresh
      • Adding auth middleware
      • Defining the routes
      • Server interface
    • Setting up factories
      • Authorizer
      • SQLite
      • Bolt
      • Service
      • Server
    • The cmd package
      • App configuration
        • Port option
        • Bolt option
        • SQLite option
        • JWT Key option
      • CLI flags
      • OS environment variables
      • Improving the factory
      • Server runtime
  • Observability and middleware
    • keys.Repository observability
    • user.Repository observability
    • secret.Repository observability
    • shared.Repository observability
    • authz.Authorizer observability
    • service.Service observability
    • Updating factories
    • HTTP observability
  • Wrapping up
  • Final thoughts