soup_hsts_enforcer_new ()

SoupHSTSEnforcer *
soup_hsts_enforcer_new (void);

Creates a new SoupHSTSEnforcer. The base SoupHSTSEnforcer class does not support persistent storage of HSTS policies, see SoupHSTSEnforcerDB for that.

Since: 2.68

soup_hsts_enforcer_is_persistent ()

gboolean
soup_hsts_enforcer_is_persistent (SoupHSTSEnforcer *hsts_enforcer);

Gets whether hsts_enforcer stores policies persistenly.

Since: 2.68

soup_hsts_enforcer_has_valid_policy ()

gboolean
soup_hsts_enforcer_has_valid_policy (SoupHSTSEnforcer *hsts_enforcer,
                                     const char *domain);

Gets whether hsts_enforcer has a currently valid policy for domain .

Since: 2.68

soup_hsts_enforcer_set_policy ()

void
soup_hsts_enforcer_set_policy (SoupHSTSEnforcer *hsts_enforcer,
                               SoupHSTSPolicy *policy);

Sets policy to hsts_enforcer . If policy is expired, any existing HSTS policy for its host will be removed instead. If a policy existed for this host, it will be replaced. Otherwise, the new policy will be inserted. If the policy is a session policy, that is, one created with soup_hsts_policy_new_session_policy(), the policy will not expire and will be enforced during the lifetime of hsts_enforcer 's SoupSession.

Since: 2.68

soup_hsts_enforcer_set_session_policy ()

void
soup_hsts_enforcer_set_session_policy (SoupHSTSEnforcer *hsts_enforcer,
                                       const char *domain,
                                       gboolean include_subdomains);

Sets a session policy for domain . A session policy is a policy that is permanent to the lifetime of hsts_enforcer 's SoupSession and doesn't expire.

Since: 2.68

soup_hsts_enforcer_get_domains ()

GList *
soup_hsts_enforcer_get_domains (SoupHSTSEnforcer *hsts_enforcer,
                                gboolean session_policies);

Gets a list of domains for which there are policies in enforcer .

Since: 2.68

soup_hsts_enforcer_get_policies ()

GList *
soup_hsts_enforcer_get_policies (SoupHSTSEnforcer *hsts_enforcer,
                                 gboolean session_policies);

Gets a list with the policies in enforcer .

Since: 2.68

soup_hsts_policy_new ()

SoupHSTSPolicy *
soup_hsts_policy_new (const char *domain,
                      unsigned long  max_age,
                      gboolean include_subdomains);

Creates a new SoupHSTSPolicy with the given attributes.

domain is a domain on which the strict transport security policy represented by this object must be enforced.

max_age is used to set the "expires" attribute on the policy; pass SOUP_HSTS_POLICY_MAX_AGE_PAST for an already-expired policy, or a lifetime in seconds.

If include_subdomains is TRUE, the strict transport security policy must also be enforced on all subdomains of domain .

Since: 2.68

soup_hsts_policy_new_full ()

SoupHSTSPolicy *
soup_hsts_policy_new_full (const char *domain,
                           unsigned long  max_age,
                           SoupDate *expires,
                           gboolean include_subdomains);

Full version of soup_hsts_policy_new(), to use with an existing expiration date. See soup_hsts_policy_new() for details.

Since: 2.68

soup_hsts_policy_new_from_response ()

SoupHSTSPolicy *
soup_hsts_policy_new_from_response (SoupMessage *msg);

Parses msg 's first "Strict-Transport-Security" response header and returns a SoupHSTSPolicy.

Since: 2.68

soup_hsts_policy_copy ()

SoupHSTSPolicy *
soup_hsts_policy_copy (SoupHSTSPolicy *policy);

Copies policy .

Since: 2.68

soup_hsts_policy_equal ()

gboolean
soup_hsts_policy_equal (SoupHSTSPolicy *policy1,
                        SoupHSTSPolicy *policy2);

Tests if policy1 and policy2 are equal.

Since: 2.68

soup_hsts_policy_free ()

void
soup_hsts_policy_free (SoupHSTSPolicy *policy);

Frees policy .

Since: 2.68

soup_hsts_policy_get_domain ()

const char *
soup_hsts_policy_get_domain (SoupHSTSPolicy *policy);

Gets policy 's domain.

Since: 2.68

soup_hsts_policy_is_expired ()

gboolean
soup_hsts_policy_is_expired (SoupHSTSPolicy *policy);

Gets whether policy is expired. Permanent policies never expire.

Since: 2.68

soup_hsts_policy_includes_subdomains ()

gboolean
soup_hsts_policy_includes_subdomains (SoupHSTSPolicy *policy);

Gets whether policy include its subdomains.

Since: 2.68

soup_hsts_policy_is_session_policy ()

gboolean
soup_hsts_policy_is_session_policy (SoupHSTSPolicy *policy);

Gets whether policy is a non-permanent, non-expirable session policy. see soup_hsts_policy_new_session_policy() for details.

Since: 2.68

SoupHSTSEnforcer

typedef struct _SoupHSTSEnforcer SoupHSTSEnforcer;

SoupHSTSEnforcerClass

typedef struct {
	GObjectClass parent_class;

	gboolean (*is_persistent) (SoupHSTSEnforcer *hsts_enforcer);
	gboolean (*has_valid_policy) (SoupHSTSEnforcer *hsts_enforcer, const char *domain);

	/* signals */
	void (*changed) (SoupHSTSEnforcer *enforcer,
			 SoupHSTSPolicy	  *old_policy,
			 SoupHSTSPolicy	  *new_policy);

	void (*hsts_enforced) (SoupHSTSEnforcer *enforcer,
			       SoupMessage      *message);

	/* Padding for future expansion */
	void (*_libsoup_reserved1) (void);
	void (*_libsoup_reserved2) (void);
	void (*_libsoup_reserved3) (void);
	void (*_libsoup_reserved4) (void);
} SoupHSTSEnforcerClass;

SoupHSTSPolicy

typedef struct {
	char                 *domain;
	unsigned long         max_age;
	SoupDate             *expires;
	gboolean              include_subdomains;
} SoupHSTSPolicy;

An HTTP Strict Transport Security policy.

domain represents the host that this policy applies to. The domain must be IDNA-canonicalized. soup_hsts_policy_new() and related methods will do this for you.

max_age contains the 'max-age' value from the Strict Transport Security header and indicates the time to live of this policy, in seconds.

expires will be non-NULL if the policy has been set by the host and hence has an expiry time. If expires is NULL, it indicates that the policy is a permanent session policy set by the user agent.

If include_subdomains is TRUE, the Strict Transport Security policy must also be enforced on subdomains of domain .

Since: 2.68

SOUP_HSTS_POLICY_MAX_AGE_PAST

#define SOUP_HSTS_POLICY_MAX_AGE_PAST (0)

The “changed” signal

void
user_function (SoupHSTSEnforcer *hsts_enforcer,
               SoupHSTSPolicy   *old_policy,
               SoupHSTSPolicy   *new_policy,
               gpointer          user_data)

Emitted when hsts_enforcer changes. If a policy has been added, new_policy will contain the newly-added policy and old_policy will be NULL. If a policy has been deleted, old_policy will contain the to-be-deleted policy and new_policy will be NULL. If a policy has been changed, old_policy will contain its old value, and new_policy its new value.

Note that you shouldn't modify the policies from a callback to this signal.

Flags: Run First

The “hsts-enforced” signal

void
user_function (SoupHSTSEnforcer *hsts_enforcer,
               SoupMessage      *message,
               gpointer          user_data)

Emitted when hsts_enforcer has upgraded the protocol for message to HTTPS as a result of matching its domain with a HSTS policy.

Flags: Run First