Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Configuring a Referer Validation ACL
Updated on 2024-08-09 GMT+08:00

Configuring a Referer Validation ACL

Function

You can configure a referer validation access control list (ACL), based on which Live will identify and filter access requests of users. Only qualified users can access the content.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/guard/referer-chain

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Domain name

guard_switch

Yes

String

Whether to enable referer validation. true: enable; false: disable.

referer_config_empty

No

String

Whether the referer header is included. true: included; false: not included. This parameter is mandatory when guard_switch is set to true.

referer_white_list

No

String

Whether it is a referer whitelist. true: whitelist; false: blacklist. This parameter is mandatory when guard_switch is set to true.

referer_auth_list

No

Array of strings

Domain name list. Each domain name is a regular expression. A maximum of 100 domain names can be included and separated by semicolons (;). This parameter is mandatory when guard_switch is set to true.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

PUT https://{endpoint}/v1/{project_id}/guard/referer-chain

{
  "domain" : "play.example.huawei.com",
  "guard_switch" : "true",
  "referer_config_empty" : "true",
  "referer_white_list" : "false",
  "referer_auth_list" : [ "^http://test.*com$", "abc.com" ]
}

Example Responses

Status code: 400

Configuring the referer validation ACL failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

SDK Sample Code

The SDK sample code is as follows.

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class SetRefererChainSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        SetRefererChainRequest request = new SetRefererChainRequest();
        SetRefererChainInfo body = new SetRefererChainInfo();
        List<String> listbodyRefererAuthList = new ArrayList<>();
        listbodyRefererAuthList.add("^http://test.*com$");
        listbodyRefererAuthList.add("abc.com");
        body.withRefererAuthList(listbodyRefererAuthList);
        body.withRefererWhiteList(SetRefererChainInfo.RefererWhiteListEnum.fromValue("false"));
        body.withRefererConfigEmpty(SetRefererChainInfo.RefererConfigEmptyEnum.fromValue("true"));
        body.withGuardSwitch(SetRefererChainInfo.GuardSwitchEnum.fromValue("true"));
        body.withDomain("play.example.huawei.com");
        request.withBody(body);
        try {
            SetRefererChainResponse response = client.setRefererChain(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SetRefererChainRequest()
        listRefererAuthListbody = [
            "^http://test.*com$",
            "abc.com"
        ]
        request.body = SetRefererChainInfo(
            referer_auth_list=listRefererAuthListbody,
            referer_white_list="false",
            referer_config_empty="true",
            guard_switch="true",
            domain="play.example.huawei.com"
        )
        response = client.set_referer_chain(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetRefererChainRequest{}
	var listRefererAuthListbody = []string{
        "^http://test.*com$",
	    "abc.com",
    }
	refererWhiteListSetRefererChainInfo:= model.GetSetRefererChainInfoRefererWhiteListEnum().FALSE
	refererConfigEmptySetRefererChainInfo:= model.GetSetRefererChainInfoRefererConfigEmptyEnum().TRUE
	request.Body = &model.SetRefererChainInfo{
		RefererAuthList: &listRefererAuthListbody,
		RefererWhiteList: &refererWhiteListSetRefererChainInfo,
		RefererConfigEmpty: &refererConfigEmptySetRefererChainInfo,
		GuardSwitch: model.GetSetRefererChainInfoGuardSwitchEnum().TRUE,
		Domain: "play.example.huawei.com",
	}
	response, err := client.SetRefererChain(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Referer validation ACL configured.

400

Configuring the referer validation ACL failed.

Error Codes

See Error Codes.