Makefile 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. ################################################################################
  2. # Build & release helpers
  3. ################################################################################
  4. DOCKER_IMAGE_TAG_GO_RELEASER := goreleaser/goreleaser:v2.15.4
  5. # Docker builds cannot load a macOS USB PKCS#11 token. Options: (1) SKIP_CODE_SIGN=1 and skip;
  6. # (2) SIGN_HTTP_URL=http://host.docker.internal:8765 plus `make sign-server` on the host to
  7. # sign via HTTP; (3) run release-sign with host goreleaser (no Docker).
  8. SKIP_CODE_SIGN ?= 1
  9. # When set (e.g. http://host.docker.internal:8765), GoReleaser in Docker calls the host
  10. # sign_server to run PKCS#11 signing on the same bind-mounted dist/ tree.
  11. SIGN_HTTP_URL ?=
  12. SIGN_SERVER_TOKEN ?=
  13. GORELEASER ?= goreleaser
  14. GOLANGCI_LINT ?= golangci-lint
  15. DOCKER_RUN_GO_RELEASER := @docker run \
  16. --env CGO_ENABLED=0 \
  17. --env GITHUB_TOKEN=$(GITHUB_TOKEN) \
  18. --env SKIP_CODE_SIGN=$(SKIP_CODE_SIGN) \
  19. --env SIGN_HTTP_URL=$(SIGN_HTTP_URL) \
  20. --env SIGN_SERVER_TOKEN=$(SIGN_SERVER_TOKEN) \
  21. --rm \
  22. --volume `pwd`:/go/src/open-oscar-server \
  23. --workdir /go/src/open-oscar-server \
  24. $(DOCKER_IMAGE_TAG_GO_RELEASER)
  25. OSCAR_HOST ?= ras.dev
  26. .PHONY: config-basic config-ssl config
  27. config-basic: ## Generate basic config file template
  28. go run ./cmd/config_generator unix config/settings.env basic
  29. config-ssl: ## Generate SSL config file template
  30. go run ./cmd/config_generator unix config/ssl/settings.env ssl
  31. config: config-basic config-ssl ## Generate all config file templates from Config struct
  32. .PHONY: lint
  33. lint: ## Run formatting and static analysis checks
  34. @fmt_output="$$(gofmt -s -l .)"; \
  35. if [ -n "$$fmt_output" ]; then \
  36. echo "The following files need formatting:"; \
  37. echo "$$fmt_output"; \
  38. exit 1; \
  39. fi
  40. $(GOLANGCI_LINT) run ./...
  41. go vet ./...
  42. .PHONY: release
  43. release: ## Run a clean, full GoReleaser run (publish + validate)
  44. $(DOCKER_RUN_GO_RELEASER) --clean
  45. .PHONY: release-dry-run
  46. release-dry-run: ## GoReleaser dry-run (skips validate & publish)
  47. $(DOCKER_RUN_GO_RELEASER) --clean --skip=validate --skip=publish
  48. SIGN_SERVER_PORT ?= 8765
  49. .PHONY: sign-server
  50. sign-server: ## Local HTTP signer for Windows PE (run before Docker release if using SIGN_HTTP_URL)
  51. go run ./cmd/sign_server
  52. .PHONY: sign-server-stop
  53. sign-server-stop: ## Stop whatever is listening on SIGN_SERVER_PORT (usually a leftover sign_server)
  54. -@kill $$(lsof -t -iTCP:$(SIGN_SERVER_PORT) -sTCP:LISTEN) 2>/dev/null || true
  55. # Default URL for GoReleaser-in-Docker → host signing (Docker Desktop Mac/Win).
  56. # On Linux Docker, use host.docker.internal:8765 only if you add
  57. # --add-host=host.docker.internal:host-gateway to the docker run (or set SIGN_DOCKER_URL).
  58. SIGN_DOCKER_URL ?= http://host.docker.internal:8765
  59. .PHONY: release-dry-run-sign-docker
  60. release-dry-run-sign-docker: ## Dry-run in Docker; Windows Authenticode via host sign_server (run `make sign-server` first)
  61. @$(MAKE) release-dry-run SIGN_HTTP_URL=$(SIGN_DOCKER_URL)
  62. .PHONY: release-sign-docker
  63. release-sign-docker: ## Full release in Docker; Windows Authenticode via host sign_server (run `make sign-server` first)
  64. @$(MAKE) release SIGN_HTTP_URL=$(SIGN_DOCKER_URL)
  65. .PHONY: release-dry-run-nosign
  66. release-dry-run-nosign: ## GoReleaser dry-run on host without Windows Authenticode
  67. SKIP_CODE_SIGN=1 $(GORELEASER) --clean --skip=validate --skip=publish
  68. .PHONY: release-nosign
  69. release-nosign: ## Full GoReleaser on host without Windows Authenticode
  70. SKIP_CODE_SIGN=1 $(GORELEASER) --clean
  71. .PHONY: release-dry-run-sign
  72. release-dry-run-sign: ## GoReleaser dry-run on host with Windows signing (needs $(GORELEASER), PKCS#11 env)
  73. SKIP_CODE_SIGN=0 $(GORELEASER) --clean --skip=validate --skip=publish
  74. .PHONY: release-sign
  75. release-sign: ## Full GoReleaser on host with Windows signing (needs $(GORELEASER), PKCS#11 env)
  76. SKIP_CODE_SIGN=0 $(GORELEASER) --clean
  77. .PHONY: docker-image-ras
  78. docker-image-ras: ## Build Open OSCAR Server image
  79. docker build -t ras:latest -f Dockerfile .
  80. .PHONY: docker-image-stunnel
  81. docker-image-stunnel: ## Build stunnel image pinned to v5.75 / OpenSSL 1.0.2u
  82. docker build -t ras-stunnel:5.75-openssl-1.0.2u -f Dockerfile.stunnel .
  83. .PHONY: docker-image-certgen
  84. docker-image-certgen: ## Build minimal helper image with openssl & nss tools
  85. docker build -t ras-certgen:latest -f Dockerfile.certgen .
  86. .PHONY: docker-images
  87. docker-images: docker-image-ras docker-image-stunnel docker-image-certgen
  88. .PHONY: docker-run
  89. docker-run:
  90. OSCAR_HOST=$(OSCAR_HOST) docker compose up open-oscar-server stunnel
  91. .PHONY: docker-run-bg
  92. docker-run-bg: ## Run Open OSCAR Server in background with docker-compose
  93. OSCAR_HOST=$(OSCAR_HOST) docker compose up -d open-oscar-server stunnel
  94. .PHONY: docker-run-stop
  95. docker-run-stop: ## Stop Open OSCAR Server docker-compose services
  96. OSCAR_HOST=$(OSCAR_HOST) docker compose down
  97. .PHONY: run
  98. run: # run the server with plain socket config
  99. ./scripts/run_dev.sh ./config/settings.env
  100. .PHONY: run-ssl
  101. run-ssl: # run the server with ssl socket config
  102. ./scripts/run_dev.sh ./config/ssl/settings.env
  103. .PHONY: run-stunnel
  104. run-stunnel: # run stunnel for SSL termination
  105. ./scripts/run_stunnel.sh ./certs/server.pem
  106. ################################################################################
  107. # SSL Helpers
  108. ################################################################################
  109. .PHONY: docker-cert
  110. docker-cert: clean-certs ## Create SSL certificates for server
  111. mkdir -p certs/
  112. OSCAR_HOST=$(OSCAR_HOST) docker compose run --no-TTY --rm cert-gen
  113. .PHONY: docker-nss
  114. docker-nss: ## Create NSS certificate database for AIM 6.x clients
  115. OSCAR_HOST=$(OSCAR_HOST) docker compose run --no-TTY --rm nss-gen
  116. .PHONY: clean-certs
  117. clean-certs: ## Remove all generated certificates & NSS DB
  118. rm -rf certs/*
  119. ################################################################################
  120. # Web API Tools
  121. ################################################################################
  122. .PHONY: webapi-keygen
  123. webapi-keygen: ## Build the Web API key generator tool
  124. go build -o webapi_keygen ./cmd/webapi_keygen
  125. .PHONY: webapi-keygen-install
  126. webapi-keygen-install: ## Install the Web API key generator tool system-wide
  127. go install ./cmd/webapi_keygen