Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for secure-context headers in ran. #35

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added support for secure-context headers in ran. #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 42 additions & 34 deletions global/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ ServeAll: %t
Gzip: %t
NoCache: %t
CORS: %t
SecureContext: %t
Debug: %t
Auth: %s
Path401: %s
Expand All @@ -225,6 +226,7 @@ Path401: %s
this.Gzip,
this.NoCache,
this.CORS,
this.SecureContext,
this.Debug,
auth,
path401,
Expand Down Expand Up @@ -294,6 +296,11 @@ Options:
If the request header has a Origin field, then it's value is used in Access-Control-Allow-Origin.
Default is false.

-secure-context=<bool> If true, ran will write some cross-origin security headers to the response:
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Embedder-Policy: require-corp
Default is false.

-am, -auth-method=<auth> Set authentication method, valid values are basic and digest. Default is basic.
-a, -auth=<user:pass> Turn on authentication and set username and password (separate by colon).
After turn on authentication, all the page require authentication.
Expand Down Expand Up @@ -354,40 +361,41 @@ func LoadConfig(versionInfo string) {
// TODO: load config file
}

flag.StringVar(&bindip, "b", "", "IP addresses binded to ran server")
flag.StringVar(&bindip, "bind-ip", "", "IP addresses binded to ran server")
flag.UintVar( &port, "p", 0, "HTTP port")
flag.UintVar( &port, "port", 0, "HTTP port")
flag.StringVar(&root, "r", "", "Root path of the website")
flag.StringVar(&root, "root", "", "Root path of the website")
flag.StringVar(&path404, "404", "", "Path of a custom 404 file")
flag.StringVar(&path401, "401", "", "Path of a custom 401 file")
flag.StringVar(&authMethod, "am", "basic", "authentication method")
flag.StringVar(&authMethod, "auth-method", "basic", "authentication method")
flag.StringVar(&auth, "a", "", "Username and password of auth, separate by colon")
flag.StringVar(&auth, "auth", "", "Username and password of auth, separate by colon")
flag.Var( &indexName, "i", "File name of index, separate by colon")
flag.Var( &indexName, "index", "File name of index, separate by colon")
flag.BoolVar( &Config.ListDir, "l", false, "Show file list of a directory")
flag.BoolVar( &Config.ListDir, "listdir", false, "Show file list of a directory")
flag.BoolVar( &Config.ServeAll, "sa", false, "Serve all paths even if the path is start with dot")
flag.BoolVar( &Config.ServeAll, "serve-all", false, "Serve all paths even if the path is start with dot")
flag.BoolVar( &Config.Gzip, "g", true, "Turn on/off gzip compression")
flag.BoolVar( &Config.Gzip, "gzip", true, "Turn on/off gzip compression")
flag.BoolVar( &Config.NoCache, "nc", false, "If send no-cache header")
flag.BoolVar( &Config.NoCache, "no-cache", false, "If send no-cache header")
flag.BoolVar( &Config.CORS, "cors", false, "If send CORS headers")
flag.BoolVar( &Config.ShowConf, "showconf", false, "If show config info in the log")
flag.BoolVar( &Config.Debug, "debug", false, "Turn on debug mode")
flag.BoolVar( &version, "v", false, "Show version information")
flag.BoolVar( &version, "version", false, "Show version information")
flag.BoolVar( &help, "h", false, "Show help message")
flag.BoolVar( &help, "help", false, "Show help message")
flag.BoolVar( &makeCert, "make-cert", false, "Generate a self-signed certificate and a private key")
flag.StringVar(&certPath, "cert", "", "Path of certificate")
flag.StringVar(&keyPath, "key", "", "Path of private key")
flag.UintVar( &tlsPort, "tls-port", 0, "HTTPS port")
flag.StringVar(&tlsPolicy, "tls-policy", "", "TLS policy")
flag.StringVar(&bindip, "b", "", "IP addresses binded to ran server")
flag.StringVar(&bindip, "bind-ip", "", "IP addresses binded to ran server")
flag.UintVar( &port, "p", 0, "HTTP port")
flag.UintVar( &port, "port", 0, "HTTP port")
flag.StringVar(&root, "r", "", "Root path of the website")
flag.StringVar(&root, "root", "", "Root path of the website")
flag.StringVar(&path404, "404", "", "Path of a custom 404 file")
flag.StringVar(&path401, "401", "", "Path of a custom 401 file")
flag.StringVar(&authMethod, "am", "basic", "authentication method")
flag.StringVar(&authMethod, "auth-method", "basic", "authentication method")
flag.StringVar(&auth, "a", "", "Username and password of auth, separate by colon")
flag.StringVar(&auth, "auth", "", "Username and password of auth, separate by colon")
flag.Var( &indexName, "i", "File name of index, separate by colon")
flag.Var( &indexName, "index", "File name of index, separate by colon")
flag.BoolVar( &Config.ListDir, "l", false, "Show file list of a directory")
flag.BoolVar( &Config.ListDir, "listdir", false, "Show file list of a directory")
flag.BoolVar( &Config.ServeAll, "sa", false, "Serve all paths even if the path is start with dot")
flag.BoolVar( &Config.ServeAll, "serve-all", false, "Serve all paths even if the path is start with dot")
flag.BoolVar( &Config.Gzip, "g", true, "Turn on/off gzip compression")
flag.BoolVar( &Config.Gzip, "gzip", true, "Turn on/off gzip compression")
flag.BoolVar( &Config.NoCache, "nc", false, "If send no-cache header")
flag.BoolVar( &Config.NoCache, "no-cache", false, "If send no-cache header")
flag.BoolVar( &Config.CORS, "cors", false, "If send CORS headers")
flag.BoolVar( &Config.SecureContext, "secure-context", false, "If send secure context headers")
flag.BoolVar( &Config.ShowConf, "showconf", false, "If show config info in the log")
flag.BoolVar( &Config.Debug, "debug", false, "Turn on debug mode")
flag.BoolVar( &version, "v", false, "Show version information")
flag.BoolVar( &version, "version", false, "Show version information")
flag.BoolVar( &help, "h", false, "Show help message")
flag.BoolVar( &help, "help", false, "Show help message")
flag.BoolVar( &makeCert, "make-cert", false, "Generate a self-signed certificate and a private key")
flag.StringVar(&certPath, "cert", "", "Path of certificate")
flag.StringVar(&keyPath, "key", "", "Path of private key")
flag.UintVar( &tlsPort, "tls-port", 0, "HTTPS port")
flag.StringVar(&tlsPolicy, "tls-policy", "", "TLS policy")

flag.Usage = usage

Expand Down
5 changes: 5 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ Options:
Access-Control-Allow-Headers: *
If the request header has a Origin field, then it's value is used in Access-Control-Allow-Origin.
Default is false.
-secure-context=<bool> If true, ran will write some cross-origin security headers to the response:
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Embedder-Policy: require-corp
Default is false.


-am, -auth-method=<auth> Set authentication method, valid values are basic and digest. Default is basic.
-a, -auth=<user:pass> Turn on authentication and set username and password (separate by colon).
Expand Down
33 changes: 17 additions & 16 deletions server/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,23 @@ type ErrorFilePath struct {


type Config struct {
Root string // Root path of the website. Default is current working directory.
Path404 *ErrorFilePath // Path of custom 404 file, under directory of Root.
// When a 404 not found error occurs, the file's content will be send to client.
// nil means do not use 404 file.
Path401 *ErrorFilePath // Path of custom 401 file, under directory of Root.
// When a 401 unauthorized error occurs, the file's content will be send to client.
// nil means do not use 401 file.
IndexName Index // File name of index, priority depends on the order of values.
// Default is []string{"index.html", "index.htm"}.
ListDir bool // If no index file provide, show file list of the directory.
// Default is false.
Gzip bool // If turn on gzip compression, default is true.
NoCache bool // If true, ran will write some no-cache headers to the response. Default is false.
CORS bool // If true, ran will write some CORS headers to the response. Default is false.
Auth *Auth // If not nil, turn on authentication.
ServeAll bool // If is false, path start with dot will not be served, that means a 404 error will be returned.
Root string // Root path of the website. Default is current working directory.
Path404 *ErrorFilePath // Path of custom 404 file, under directory of Root.
// When a 404 not found error occurs, the file's content will be send to client.
// nil means do not use 404 file.
Path401 *ErrorFilePath // Path of custom 401 file, under directory of Root.
// When a 401 unauthorized error occurs, the file's content will be send to client.
// nil means do not use 401 file.
IndexName Index // File name of index, priority depends on the order of values.
// Default is []string{"index.html", "index.htm"}.
ListDir bool // If no index file provide, show file list of the directory.
// Default is false.
Gzip bool // If turn on gzip compression, default is true.
NoCache bool // If true, ran will write some no-cache headers to the response. Default is false.
CORS bool // If true, ran will write some CORS headers to the response. Default is false.
SecureContext bool // If true, ran will write some cross-origin security headers to the response. Default is false.
Auth *Auth // If not nil, turn on authentication.
ServeAll bool // If is false, path start with dot will not be served, that means a 404 error will be returned.
}


10 changes: 10 additions & 0 deletions server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ func setCORSHeader(w http.ResponseWriter, r *http.Request) {
}


func setSecureContextHeader(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Cross-Origin-Opener-Policy", "same-origin")
w.Header().Set("Cross-Origin-Embedder-Policy", "require-corp")
}


func (this *RanServer) serveHTTP(w http.ResponseWriter, r *http.Request) {

requestId := string(getRequestId(r.URL.String()))
Expand All @@ -96,6 +102,10 @@ func (this *RanServer) serveHTTP(w http.ResponseWriter, r *http.Request) {
setCORSHeader(w, r)
}

if (this.config.SecureContext) {
setSecureContextHeader(w, r)
}

this.logger.Debugf("#%s: r.URL: [%s], r.URL.Path: [%s]", requestId, r.URL.String(), r.URL.Path)

context, err := newContext(this.config, r)
Expand Down