1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
|
// Copyright 2025 OpenPubkey
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
package choosers
import (
"context"
"embed"
"errors"
"fmt"
"html/template"
"io/fs"
"net"
"net/http"
"net/http/httptest"
"sort"
"strings"
"github.com/openpubkey/openpubkey/providers"
"github.com/openpubkey/openpubkey/util"
"github.com/sirupsen/logrus"
)
//go:embed static/*
var staticFiles embed.FS
//go:embed chooser.tmpl
var chooserTemplateFile string
// To add support for an OP to the the WebChooser:
// 1. Add the OP to IssuerToName func
// 2. Add the OP to the html template file: `chooser.tmpl`
// 3. Add the OP to the data which is supplied to `chooserTemplate.Execute(w, data)`
//
// Note that the web chooser can only support BrowserOpenIdProvider
// TODO: This should be an enum that can also autogenerate what gets passed to the template
type WebChooser struct {
OpList []providers.BrowserOpenIdProvider
opSelected providers.BrowserOpenIdProvider
OpenBrowser bool
useMockServer bool
mockServer *httptest.Server
server *http.Server
}
func NewWebChooser(opList []providers.BrowserOpenIdProvider, openBrowser bool) *WebChooser {
return &WebChooser{
OpList: opList,
OpenBrowser: openBrowser,
useMockServer: false,
}
}
func (wc *WebChooser) ChooseOp(ctx context.Context) (providers.OpenIdProvider, error) {
if wc.opSelected != nil {
return nil, fmt.Errorf("provider has already been chosen")
}
providerMap := map[string]providers.BrowserOpenIdProvider{}
for _, provider := range wc.OpList {
if providerName, err := IssuerToName(provider.Issuer()); err != nil {
return nil, err
} else {
if _, ok := providerMap[providerName]; ok {
return nil, fmt.Errorf("provider in web chooser found with duplicate issuer: %s", provider.Issuer())
}
providerMap[providerName] = provider
}
}
opCh := make(chan providers.BrowserOpenIdProvider, 1)
errCh := make(chan error, 1)
mux := http.NewServeMux()
staticContent, err := fs.Sub(staticFiles, "static")
if err != nil {
return nil, err
}
chooserTemplate, err := template.New("chooser-page").Parse(chooserTemplateFile)
if err != nil {
return nil, err
}
mux.HandleFunc("/chooser", func(w http.ResponseWriter, r *http.Request) {
type Provider struct {
Name string
Button string
}
data := struct {
Providers []Provider
}{}
sortedProviderNames := make([]string, 0)
for providerName := range providerMap {
sortedProviderNames = append(sortedProviderNames, providerName)
}
// Sort the provider names
sort.Strings(sortedProviderNames)
for _, providerName := range sortedProviderNames {
if providerName == "google" {
data.Providers = append(data.Providers, Provider{
Name: providerName,
Button: "google-light.svg",
})
continue
}
if providerName == "azure" {
data.Providers = append(data.Providers, Provider{
Name: providerName,
Button: "azure-dark.svg",
})
continue
}
if providerName == "gitlab" {
data.Providers = append(data.Providers, Provider{
Name: providerName,
Button: "gitlab-light.svg",
})
continue
}
if providerName == "hello" {
data.Providers = append(data.Providers, Provider{
Name: providerName,
Button: "hello-dark.png",
})
continue
}
data.Providers = append(data.Providers, Provider{
Name: providerName,
Button: "",
})
}
w.Header().Set("Content-Type", "text/html")
if err := chooserTemplate.Execute(w, data); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
}
})
mux.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.FS(staticContent))))
mux.HandleFunc("/select/", func(w http.ResponseWriter, r *http.Request) {
// Once we redirect to the OP localhost webserver, we can shutdown the web chooser localhost server
shutdownServer := func() {
go func() { // Put this in a go func so that it will not block the redirect
if wc.server != nil {
if err := wc.server.Shutdown(ctx); err != nil {
logrus.Errorf("Failed to shutdown http server: %v", err)
}
}
}()
}
defer shutdownServer()
opName := r.URL.Query().Get("op")
if opName == "" {
errorString := "missing op parameter"
http.Error(w, errorString, http.StatusBadRequest)
errCh <- errors.New(errorString)
return
}
if op, ok := providerMap[opName]; !ok {
errorString := fmt.Sprintf("unknown OpenID Provider: %s", opName)
http.Error(w, errorString, http.StatusBadRequest)
errCh <- errors.New(errorString)
return
} else {
opCh <- op
redirectUriCh := make(chan string, 1)
op.ReuseBrowserWindowHook(redirectUriCh)
redirectUri := <-redirectUriCh
http.Redirect(w, r, redirectUri, http.StatusFound)
}
})
if wc.useMockServer {
wc.mockServer = httptest.NewUnstartedServer(mux)
wc.mockServer.Start()
} else {
listener, err := net.Listen("tcp", "localhost:0")
if err != nil {
return nil, fmt.Errorf("failed to bind to an available port: %w", err)
}
wc.server = &http.Server{Handler: mux}
go func() {
err = wc.server.Serve(listener)
if err != nil && err != http.ErrServerClosed {
logrus.Error(err)
}
}()
var loginURI string
if listener.Addr().(*net.TCPAddr).IP.String() == "127.0.0.1" {
// For consistency in output messages in our code base we use localhost rather than 127.0.0.1
port := listener.Addr().(*net.TCPAddr).Port
loginURI = fmt.Sprintf("http://localhost:%d/chooser", port)
} else {
loginURI = fmt.Sprintf("http://%s/chooser", listener.Addr().String())
}
if wc.OpenBrowser {
logrus.Infof("Opening browser to %s", loginURI)
if err := util.OpenUrl(loginURI); err != nil {
logrus.Errorf("Failed to open url: %v", err)
}
} else {
// If wc.OpenBrowser is false, tell the user what URL to open.
// This is useful when a user wants to use a different browser than the default one.
logrus.Infof("Open your browser to: %s ", loginURI)
}
}
select {
case <-ctx.Done():
return nil, ctx.Err()
case err := <-errCh:
return nil, err
case wc.opSelected = <-opCh:
return wc.opSelected, nil
}
}
func IssuerToName(issuer string) (string, error) {
switch {
case strings.HasPrefix(issuer, "https://accounts.google.com"):
return "google", nil
case strings.HasPrefix(issuer, "https://login.microsoftonline.com"):
return "azure", nil
case strings.HasPrefix(issuer, "https://gitlab.com"):
return "gitlab", nil
case strings.HasPrefix(issuer, "https://issuer.hello.coop"):
return "hello", nil
default:
if strings.HasPrefix(issuer, "https://") {
// Returns issuer without the "https://" prefix and without any path remaining on the url
// e.g. https://accounts.google.com/fdsfa/fdsafsad -> accounts.google.com
return strings.Split(strings.TrimPrefix(issuer, "https://"), "/")[0], nil
}
return "", fmt.Errorf("invalid OpenID Provider issuer: %s", issuer)
}
}
|