API: Support HTTP basic authentication for API. v6.0.4, v5.0.152

trunk/3rdparty/srs-bench/blackbox/http_api_test.go

@@ -0,0 +1,93 @@
+// The MIT License (MIT)
+//
+// # Copyright (c) 2023 Winlin
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of
+// this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to
+// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+// the Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+package blackbox
+
+import (
+    "context"
+    "fmt"
+    "github.com/ossrs/go-oryx-lib/errors"
+    "github.com/ossrs/go-oryx-lib/logger"
+    "net/http"
+    "sync"
+    "testing"
+    "time"
+)
+
+func TestFast_Http_Api_Basic_Auth(t *testing.T) {
+    // This case is run in parallel.
+    t.Parallel()
+
+    // Setup the max timeout for this case.
+    ctx, cancel := context.WithTimeout(logger.WithContext(context.Background()), time.Duration(*srsTimeout)*time.Millisecond)
+    defer cancel()
+
+    // Check a set of errors.
+    var r0, r1, r2, r3, r4, r5, r6 error
+    defer func(ctx context.Context) {
+        if err := filterTestError(ctx.Err(), r0, r1, r2, r3, r4, r5, r6); err != nil {
+            t.Errorf("Fail for err %+v", err)
+        } else {
+            logger.Tf(ctx, "test done with err %+v", err)
+        }
+    }(ctx)
+
+    var wg sync.WaitGroup
+    defer wg.Wait()
+
+    // Start SRS server and wait for it to be ready.
+    svr := NewSRSServer(func(v *srsServer) {
+        v.envs = []string{
+            "SRS_HTTP_API_AUTH_ENABLED=on",
+            "SRS_HTTP_API_AUTH_USERNAME=admin",
+            "SRS_HTTP_API_AUTH_PASSWORD=admin",
+        }
+    })
+    wg.Add(1)
+    go func() {
+        defer wg.Done()
+        r0 = svr.Run(ctx, cancel)
+    }()
+
+    <-svr.ReadyCtx().Done()
+
+    if true {
+        defer cancel()
+
+        var res *http.Response
+        url := fmt.Sprintf("http://admin:admin@localhost:%v/api/v1/versions", svr.APIPort())
+        res, r1 = http.Get(url)
+        if r1 == nil && res.StatusCode != 200 {
+            r2 = errors.Errorf("get status code=%v, expect=200", res.StatusCode)
+        }
+
+        url = fmt.Sprintf("http://admin:123456@localhost:%v/api/v1/versions", svr.APIPort())
+        res, r3 = http.Get(url)
+        if r3 == nil && res.StatusCode != 401 {
+            r4 = errors.Errorf("get status code=%v, expect=401", res.StatusCode)
+        }
+
+        url = fmt.Sprintf("http://localhost:%v/api/v1/versions", svr.APIPort())
+        res, r5 = http.Get(url)
+        if r5 == nil && res.StatusCode != 401 {
+            r6 = errors.Errorf("get status code=%v, expect=401", res.StatusCode)
+        }
+    }
+}

trunk/3rdparty/srs-bench/blackbox/util.go

@@ -329,7 +329,7 @@ func (v *backendService) Run(ctx context.Context, cancel context.CancelFunc) err
 		}
 
 		select {
-		case <- ctx.Done():
+		case <-ctx.Done():
 		case <-time.After(v.duration):
 			logger.Tf(ctx, "Process killed duration=%v, pid=%v, name=%v, args=%v", v.duration, v.pid, v.name, v.args)
 			cmd.Process.Kill()
@@ -418,6 +418,8 @@ type SRSServer interface {
 	RTMPPort() int
 	// HTTPPort is the HTTP stream port.
 	HTTPPort() int
+	// APIPort is the HTTP API port.
+	APIPort() int
 	// SRTPort is the SRT UDP port.
 	SRTPort() int
 }
@@ -510,6 +512,10 @@ func (v *srsServer) HTTPPort() int {
 	return v.httpListen
 }
 
+func (v *srsServer) APIPort() int {
+	return v.apiListen
+}
+
 func (v *srsServer) SRTPort() int {
 	return v.srtListen
 }
@@ -524,7 +530,7 @@ func (v *srsServer) Run(ctx context.Context, cancel context.CancelFunc) error {
 	)
 
 	// Create directories.
-	if err := os.MkdirAll(path.Join(v.workDir, "./objs/nginx/html"), os.FileMode(0755) | os.ModeDir); err != nil {
+	if err := os.MkdirAll(path.Join(v.workDir, "./objs/nginx/html"), os.FileMode(0755)|os.ModeDir); err != nil {
 		return errors.Wrapf(err, "SRS create directory %v", path.Join(v.workDir, "./objs/nginx/html"))
 	}
 
@@ -657,7 +663,7 @@ type ffmpegClient struct {
 
 func NewFFmpeg(opts ...func(v *ffmpegClient)) FFmpegClient {
 	v := &ffmpegClient{
-		process: newBackendService(),
+		process:            newBackendService(),
 		cancelCaseWhenQuit: true,
 	}
 
@@ -701,7 +707,7 @@ func (v *ffmpegClient) Run(ctx context.Context, cancel context.CancelFunc) error
 	ffCtx, ffCancel := context.WithCancel(ctx)
 	go func() {
 		select {
-		case <- ctx.Done():
+		case <-ctx.Done():
 		case <-ffCtx.Done():
 			if v.cancelCaseWhenQuit {
 				cancel()
@@ -1144,17 +1150,17 @@ func (v *HooksEventBase) HookAction() string {
 
 type HooksEventOnDvr struct {
 	HooksEventBase
-	Stream string `json:"stream"`
+	Stream    string `json:"stream"`
 	StreamUrl string `json:"stream_url"`
-	StreamID string `json:"stream_id"`
-	CWD string `json:"cwd"`
-	File string `json:"file"`
-	TcUrl string `json:"tcUrl"`
-	App string `json:"app"`
-	Vhost string `json:"vhost"`
-	IP string `json:"ip"`
-	ClientIP string `json:"client_id"`
-	ServerID string `json:"server_id"`
+	StreamID  string `json:"stream_id"`
+	CWD       string `json:"cwd"`
+	File      string `json:"file"`
+	TcUrl     string `json:"tcUrl"`
+	App       string `json:"app"`
+	Vhost     string `json:"vhost"`
+	IP        string `json:"ip"`
+	ClientIP  string `json:"client_id"`
+	ServerID  string `json:"server_id"`
 }
 
 type HooksService interface {
@@ -1171,7 +1177,7 @@ type hooksService struct {
 	httpPort int
 	dispose  func()
 
-	r0 error
+	r0         error
 	hooksOnDvr chan HooksEvent
 }
 

trunk/conf/full.conf

@@ -203,6 +203,19 @@ http_api {
         # Always off by https://github.com/ossrs/srs/issues/2653
         #allow_update off;
     }
+    # the auth is authentication for http api
+    auth {
+        # whether enable the HTTP AUTH.
+        # Overwrite by env SRS_HTTP_API_AUTH_ENABLED
+        # default: off
+        enabled         on;
+        # The username of Basic authentication:
+        # Overwrite by env SRS_HTTP_API_AUTH_USERNAME
+        username        admin;
+        # The password of Basic authentication:
+        # Overwrite by env SRS_HTTP_API_AUTH_PASSWORD
+        password        admin;
+    }
     # For https_api or HTTPS API.
     https {
         # Whether enable HTTPS API.

trunk/doc/CHANGELOG.md

@@ -8,6 +8,7 @@ The changelog for SRS.
 
 ## SRS 6.0 Changelog
 
+* v5.0, 2023-04-01, Merge [#3458](https://github.com/ossrs/srs/pull/3450): API: Support HTTP basic authentication for API. v6.0.40 (#3458)
 * v6.0, 2023-03-27, Merge [#3450](https://github.com/ossrs/srs/pull/3450): WebRTC: Error message carries the SDP when failed. v6.0.39 (#3450)
 * v6.0, 2023-03-25, Merge [#3477](https://github.com/ossrs/srs/pull/3477): Remove unneccessary NULL check in srs_freep. v6.0.38 (#3477)
 * v6.0, 2023-03-25, Merge [#3455](https://github.com/ossrs/srs/pull/3455): RTC: Call on_play before create session, for it might be freed for timeout. v6.0.37 (#3455)
@@ -53,6 +54,7 @@ The changelog for SRS.
 
 ## SRS 5.0 Changelog
 
+* v5.0, 2023-04-01, Merge [#3458](https://github.com/ossrs/srs/pull/3450): API: Support HTTP basic authentication for API. v5.0.152 (#3458)
 * v5.0, 2023-03-27, Merge [#3450](https://github.com/ossrs/srs/pull/3450): WebRTC: Error message carries the SDP when failed. v5.0.151 (#3450)
 * v5.0, 2023-03-25, Merge [#3477](https://github.com/ossrs/srs/pull/3477): Remove unneccessary NULL check in srs_freep. v5.0.150 (#3477)
 * v5.0, 2023-03-25, Merge [#3455](https://github.com/ossrs/srs/pull/3455): RTC: Call on_play before create session, for it might be freed for timeout. v5.0.149 (#3455)

trunk/src/app/srs_app_config.cpp

@@ -2284,7 +2284,7 @@ srs_error_t SrsConfig::check_normal_config()
         for (int i = 0; conf && i < (int)conf->directives.size(); i++) {
             SrsConfDirective* obj = conf->at(i);
             string n = obj->name;
-            if (n != "enabled" && n != "listen" && n != "crossdomain" && n != "raw_api" && n != "https") {
+            if (n != "enabled" && n != "listen" && n != "crossdomain" && n != "raw_api" && n != "auth" && n != "https") {
                 return srs_error_new(ERROR_SYSTEM_CONFIG_INVALID, "illegal http_api.%s", n.c_str());
             }
 
@@ -2296,6 +2296,15 @@ srs_error_t SrsConfig::check_normal_config()
                     }
                 }
             }
+
+            if (n == "auth") {
+                for (int j = 0; j < (int)obj->directives.size(); j++) {
+                    string m = obj->at(j)->name;
+                    if (m != "enabled" && m != "username" && m != "password") {
+                        return srs_error_new(ERROR_SYSTEM_CONFIG_INVALID, "illegal http_api.auth.%s", m.c_str());
+                    }
+                }
+            }
         }
     }
     if (true) {
@@ -7605,6 +7614,78 @@ bool SrsConfig::get_raw_api_allow_update()
     return false;
 }
 
+bool SrsConfig::get_http_api_auth_enabled()
+{
+    SRS_OVERWRITE_BY_ENV_BOOL("srs.http_api.auth.enabled"); // SRS_HTTP_API_AUTH_ENABLED
+
+    static bool DEFAULT = false;
+
+    SrsConfDirective* conf = root->get("http_api");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    conf = conf->get("auth");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    conf = conf->get("enabled");
+    if (!conf || conf->arg0().empty()) {
+        return DEFAULT;
+    }
+
+    return SRS_CONF_PERFER_FALSE(conf->arg0());
+}
+
+std::string SrsConfig::get_http_api_auth_username()
+{
+    SRS_OVERWRITE_BY_ENV_STRING("srs.http_api.auth.username"); // SRS_HTTP_API_AUTH_USERNAME
+
+    static string DEFAULT = "";
+
+    SrsConfDirective* conf = root->get("http_api");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    conf = conf->get("auth");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    conf = conf->get("username");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    return conf->arg0();
+}
+
+std::string SrsConfig::get_http_api_auth_password()
+{
+    SRS_OVERWRITE_BY_ENV_STRING("srs.http_api.auth.password"); // SRS_HTTP_API_AUTH_PASSWORD
+
+    static string DEFAULT = "";
+
+    SrsConfDirective* conf = root->get("http_api");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    conf = conf->get("auth");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    conf = conf->get("password");
+    if (!conf) {
+        return DEFAULT;
+    }
+
+    return conf->arg0();
+}
+
 SrsConfDirective* SrsConfig::get_https_api()
 {
     SrsConfDirective* conf = root->get("http_api");

trunk/src/app/srs_app_config.hpp

@@ -1021,6 +1021,12 @@ class SrsConfig
     virtual bool get_raw_api_allow_query();
     // Whether allow rpc update.
     virtual bool get_raw_api_allow_update();
+    // Whether http api auth enabled.
+    virtual bool get_http_api_auth_enabled();
+    // Get the http api auth username.
+    virtual std::string get_http_api_auth_username();
+    // Get the http api auth password.
+    virtual std::string get_http_api_auth_password();
 // https api section
 private:
     SrsConfDirective* get_https_api();