GI.Gio.Objects.TlsCertificate

A certificate used for TLS authentication and encryption. This can represent either a certificate only (eg, the certificate received by a client from a server), or the combination of a certificate and a private key (which is needed when acting as a TlsServerConnection).

Exported types

newtype TlsCertificate

Constructors

TlsCertificate (ManagedPtr TlsCertificate)

Instances

GObject TlsCertificate

Methods

gobjectType :: TlsCertificate -> IO GType

IsObject TlsCertificate

IsTlsCertificate TlsCertificate

((~) * info (ResolveTlsCertificateMethod t TlsCertificate), MethodInfo * info TlsCertificate p) => IsLabel t (TlsCertificate -> p)

Methods

fromLabel :: Proxy# Symbol t -> TlsCertificate -> p

((~) * info (ResolveTlsCertificateMethod t TlsCertificate), MethodInfo * info TlsCertificate p) => IsLabelProxy t (TlsCertificate -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> TlsCertificate -> p

HasAttributeList * TlsCertificate

type AttributeList TlsCertificate

type AttributeList TlsCertificate

type SignalList TlsCertificate

type SignalList TlsCertificate

class GObject o => IsTlsCertificate o

Instances

(GObject a, UnknownAncestorError Constraint TlsCertificate a) => IsTlsCertificate a

IsTlsCertificate TlsCertificate

toTlsCertificate :: IsTlsCertificate o => o -> IO TlsCertificate

noTlsCertificate :: Maybe TlsCertificate

Methods

getIssuer

data TlsCertificateGetIssuerMethodInfo

Instances

((~) * signature (m TlsCertificate), MonadIO m, IsTlsCertificate a) => MethodInfo * TlsCertificateGetIssuerMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TlsCertificateGetIssuerMethodInfo a -> signature -> s

tlsCertificateGetIssuer

Arguments

:: (HasCallStack, MonadIO m, IsTlsCertificate a)

=> a

cert: a TlsCertificate

-> m TlsCertificate

Returns: The certificate of cert's issuer, or Nothing if cert is self-signed or signed with an unknown certificate.

Gets the TlsCertificate representing cert's issuer, if known

Since: 2.28

isSame

data TlsCertificateIsSameMethodInfo

Instances

((~) * signature (b -> m Bool), MonadIO m, IsTlsCertificate a, IsTlsCertificate b) => MethodInfo * TlsCertificateIsSameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TlsCertificateIsSameMethodInfo a -> signature -> s

tlsCertificateIsSame

Arguments

:: (HasCallStack, MonadIO m, IsTlsCertificate a, IsTlsCertificate b)

=> a

certOne: first certificate to compare

-> b

certTwo: second certificate to compare

-> m Bool

Returns: whether the same or not

Check if two TlsCertificate objects represent the same certificate. The raw DER byte data of the two certificates are checked for equality. This has the effect that two certificates may compare equal even if their TlsCertificate:issuer, TlsCertificate:private-key, or TlsCertificate:private-key-pem properties differ.

Since: 2.34

listNewFromFile

tlsCertificateListNewFromFile

Arguments

:: (HasCallStack, MonadIO m)

=> [Char]

file: file containing PEM-encoded certificates to import

-> m [TlsCertificate]

Returns: a List containing TlsCertificate objects. You must free the list and its contents when you are done with it. (Can throw GError)

Creates one or more GTlsCertificates from the PEM-encoded data in file. If file cannot be read or parsed, the function will return Nothing and set error. If file does not contain any PEM-encoded certificates, this will return an empty list and not set error.

Since: 2.28

newFromFile

tlsCertificateNewFromFile

Arguments

:: (HasCallStack, MonadIO m)

=> [Char]

file: file containing a PEM-encoded certificate to import

-> m TlsCertificate

Returns: the new certificate, or Nothing on error (Can throw GError)

Creates a TlsCertificate from the PEM-encoded data in file. The returned certificate will be the first certificate found in file. As of GLib 2.44, if file contains more certificates it will try to load a certificate chain. All certificates will be verified in the order found (top-level certificate should be the last one in the file) and the TlsCertificate:issuer property of each certificate will be set accordingly if the verification succeeds. If any certificate in the chain cannot be verified, the first certificate in the file will still be returned.

If file cannot be read or parsed, the function will return Nothing and set error. Otherwise, this behaves like tlsCertificateNewFromPem.

Since: 2.28

newFromFiles

tlsCertificateNewFromFiles

Arguments

:: (HasCallStack, MonadIO m)

=> [Char]

certFile: file containing one or more PEM-encoded certificates to import

-> [Char]

keyFile: file containing a PEM-encoded private key to import

-> m TlsCertificate

Returns: the new certificate, or Nothing on error (Can throw GError)

Creates a TlsCertificate from the PEM-encoded data in certFile and keyFile. The returned certificate will be the first certificate found in certFile. As of GLib 2.44, if certFile contains more certificates it will try to load a certificate chain. All certificates will be verified in the order found (top-level certificate should be the last one in the file) and the TlsCertificate:issuer property of each certificate will be set accordingly if the verification succeeds. If any certificate in the chain cannot be verified, the first certificate in the file will still be returned.

If either file cannot be read or parsed, the function will return Nothing and set error. Otherwise, this behaves like tlsCertificateNewFromPem.

Since: 2.28

newFromPem

tlsCertificateNewFromPem

Arguments

:: (HasCallStack, MonadIO m)

=> Text

data: PEM-encoded certificate data

-> Int64

length: the length of data, or -1 if it's 0-terminated.

-> m TlsCertificate

Returns: the new certificate, or Nothing if data is invalid (Can throw GError)

Creates a TlsCertificate from the PEM-encoded data in data. If data includes both a certificate and a private key, then the returned certificate will include the private key data as well. (See the TlsCertificate:private-key-pem property for information about supported formats.)

The returned certificate will be the first certificate found in data. As of GLib 2.44, if data contains more certificates it will try to load a certificate chain. All certificates will be verified in the order found (top-level certificate should be the last one in the file) and the TlsCertificate:issuer property of each certificate will be set accordingly if the verification succeeds. If any certificate in the chain cannot be verified, the first certificate in the file will still be returned.

Since: 2.28

verify

data TlsCertificateVerifyMethodInfo

Instances

((~) * signature (Maybe b -> Maybe c -> m [TlsCertificateFlags]), MonadIO m, IsTlsCertificate a, IsSocketConnectable b, IsTlsCertificate c) => MethodInfo * TlsCertificateVerifyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TlsCertificateVerifyMethodInfo a -> signature -> s

tlsCertificateVerify

Arguments

:: (HasCallStack, MonadIO m, IsTlsCertificate a, IsSocketConnectable b, IsTlsCertificate c)

=> a

cert: a TlsCertificate

-> Maybe b

identity: the expected peer identity

-> Maybe c

trustedCa: the certificate of a trusted authority

-> m [TlsCertificateFlags]

Returns: the appropriate TlsCertificateFlags

This verifies cert and returns a set of TlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system CA database.

If identity is not Nothing, cert's name(s) will be compared against it, and TlsCertificateFlagsBadIdentity will be set in the return value if it does not match. If identity is Nothing, that bit will never be set in the return value.

If trustedCa is not Nothing, then cert (or one of the certificates in its chain) must be signed by it, or else TlsCertificateFlagsUnknownCa will be set in the return value. If trustedCa is Nothing, that bit will never be set in the return value.

(All other TlsCertificateFlags values will always be set or unset as appropriate.)

Since: 2.28

Properties

certificate

data TlsCertificateCertificatePropertyInfo

Instances

AttrInfo TlsCertificateCertificatePropertyInfo

Associated Types

type AttrAllowedOps TlsCertificateCertificatePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TlsCertificateCertificatePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo :: * -> Constraint

type AttrGetType TlsCertificateCertificatePropertyInfo :: *

type AttrLabel TlsCertificateCertificatePropertyInfo :: Symbol

type AttrOrigin TlsCertificateCertificatePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo o => Proxy * TlsCertificateCertificatePropertyInfo -> o -> IO (AttrGetType TlsCertificateCertificatePropertyInfo)

attrSet :: (AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo o, AttrSetTypeConstraint TlsCertificateCertificatePropertyInfo b) => Proxy * TlsCertificateCertificatePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo o => Proxy * TlsCertificateCertificatePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo o, AttrSetTypeConstraint TlsCertificateCertificatePropertyInfo b) => Proxy * TlsCertificateCertificatePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TlsCertificateCertificatePropertyInfo

type AttrOrigin TlsCertificateCertificatePropertyInfo = TlsCertificate

type AttrLabel TlsCertificateCertificatePropertyInfo

type AttrLabel TlsCertificateCertificatePropertyInfo = "certificate"

type AttrGetType TlsCertificateCertificatePropertyInfo

type AttrGetType TlsCertificateCertificatePropertyInfo = Maybe ByteString

type AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo

type AttrBaseTypeConstraint TlsCertificateCertificatePropertyInfo = IsTlsCertificate

type AttrSetTypeConstraint TlsCertificateCertificatePropertyInfo

type AttrSetTypeConstraint TlsCertificateCertificatePropertyInfo = * ~ ByteString

type AttrAllowedOps TlsCertificateCertificatePropertyInfo

type AttrAllowedOps TlsCertificateCertificatePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructTlsCertificateCertificate :: IsTlsCertificate o => ByteString -> IO (GValueConstruct o)

getTlsCertificateCertificate :: (MonadIO m, IsTlsCertificate o) => o -> m (Maybe ByteString)

tlsCertificateCertificate :: AttrLabelProxy "certificate"

certificatePem

data TlsCertificateCertificatePemPropertyInfo

Instances

AttrInfo TlsCertificateCertificatePemPropertyInfo

Associated Types

type AttrAllowedOps TlsCertificateCertificatePemPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TlsCertificateCertificatePemPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo :: * -> Constraint

type AttrGetType TlsCertificateCertificatePemPropertyInfo :: *

type AttrLabel TlsCertificateCertificatePemPropertyInfo :: Symbol

type AttrOrigin TlsCertificateCertificatePemPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo o => Proxy * TlsCertificateCertificatePemPropertyInfo -> o -> IO (AttrGetType TlsCertificateCertificatePemPropertyInfo)

attrSet :: (AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo o, AttrSetTypeConstraint TlsCertificateCertificatePemPropertyInfo b) => Proxy * TlsCertificateCertificatePemPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo o => Proxy * TlsCertificateCertificatePemPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo o, AttrSetTypeConstraint TlsCertificateCertificatePemPropertyInfo b) => Proxy * TlsCertificateCertificatePemPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TlsCertificateCertificatePemPropertyInfo

type AttrOrigin TlsCertificateCertificatePemPropertyInfo = TlsCertificate

type AttrLabel TlsCertificateCertificatePemPropertyInfo

type AttrLabel TlsCertificateCertificatePemPropertyInfo = "certificate-pem"

type AttrGetType TlsCertificateCertificatePemPropertyInfo

type AttrGetType TlsCertificateCertificatePemPropertyInfo = Maybe Text

type AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo

type AttrBaseTypeConstraint TlsCertificateCertificatePemPropertyInfo = IsTlsCertificate

type AttrSetTypeConstraint TlsCertificateCertificatePemPropertyInfo

type AttrSetTypeConstraint TlsCertificateCertificatePemPropertyInfo = * ~ Text

type AttrAllowedOps TlsCertificateCertificatePemPropertyInfo

type AttrAllowedOps TlsCertificateCertificatePemPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructTlsCertificateCertificatePem :: IsTlsCertificate o => Text -> IO (GValueConstruct o)

getTlsCertificateCertificatePem :: (MonadIO m, IsTlsCertificate o) => o -> m (Maybe Text)

tlsCertificateCertificatePem :: AttrLabelProxy "certificatePem"

issuer

data TlsCertificateIssuerPropertyInfo

Instances

AttrInfo TlsCertificateIssuerPropertyInfo

Associated Types

type AttrAllowedOps TlsCertificateIssuerPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TlsCertificateIssuerPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo :: * -> Constraint

type AttrGetType TlsCertificateIssuerPropertyInfo :: *

type AttrLabel TlsCertificateIssuerPropertyInfo :: Symbol

type AttrOrigin TlsCertificateIssuerPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo o => Proxy * TlsCertificateIssuerPropertyInfo -> o -> IO (AttrGetType TlsCertificateIssuerPropertyInfo)

attrSet :: (AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo o, AttrSetTypeConstraint TlsCertificateIssuerPropertyInfo b) => Proxy * TlsCertificateIssuerPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo o => Proxy * TlsCertificateIssuerPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo o, AttrSetTypeConstraint TlsCertificateIssuerPropertyInfo b) => Proxy * TlsCertificateIssuerPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TlsCertificateIssuerPropertyInfo

type AttrOrigin TlsCertificateIssuerPropertyInfo = TlsCertificate

type AttrLabel TlsCertificateIssuerPropertyInfo

type AttrLabel TlsCertificateIssuerPropertyInfo = "issuer"

type AttrGetType TlsCertificateIssuerPropertyInfo

type AttrGetType TlsCertificateIssuerPropertyInfo = TlsCertificate

type AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo

type AttrBaseTypeConstraint TlsCertificateIssuerPropertyInfo = IsTlsCertificate

type AttrSetTypeConstraint TlsCertificateIssuerPropertyInfo

type AttrSetTypeConstraint TlsCertificateIssuerPropertyInfo = IsTlsCertificate

type AttrAllowedOps TlsCertificateIssuerPropertyInfo

type AttrAllowedOps TlsCertificateIssuerPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructTlsCertificateIssuer :: (IsTlsCertificate o, IsTlsCertificate a) => a -> IO (GValueConstruct o)

getTlsCertificateIssuer :: (MonadIO m, IsTlsCertificate o) => o -> m TlsCertificate

tlsCertificateIssuer :: AttrLabelProxy "issuer"

privateKey

data TlsCertificatePrivateKeyPropertyInfo

Instances

AttrInfo TlsCertificatePrivateKeyPropertyInfo

Associated Types

type AttrAllowedOps TlsCertificatePrivateKeyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TlsCertificatePrivateKeyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo :: * -> Constraint

type AttrGetType TlsCertificatePrivateKeyPropertyInfo :: *

type AttrLabel TlsCertificatePrivateKeyPropertyInfo :: Symbol

type AttrOrigin TlsCertificatePrivateKeyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo o => Proxy * TlsCertificatePrivateKeyPropertyInfo -> o -> IO (AttrGetType TlsCertificatePrivateKeyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo o, AttrSetTypeConstraint TlsCertificatePrivateKeyPropertyInfo b) => Proxy * TlsCertificatePrivateKeyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo o => Proxy * TlsCertificatePrivateKeyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo o, AttrSetTypeConstraint TlsCertificatePrivateKeyPropertyInfo b) => Proxy * TlsCertificatePrivateKeyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TlsCertificatePrivateKeyPropertyInfo

type AttrOrigin TlsCertificatePrivateKeyPropertyInfo = TlsCertificate

type AttrLabel TlsCertificatePrivateKeyPropertyInfo

type AttrLabel TlsCertificatePrivateKeyPropertyInfo = "private-key"

type AttrGetType TlsCertificatePrivateKeyPropertyInfo

type AttrGetType TlsCertificatePrivateKeyPropertyInfo = ()

type AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo

type AttrBaseTypeConstraint TlsCertificatePrivateKeyPropertyInfo = IsTlsCertificate

type AttrSetTypeConstraint TlsCertificatePrivateKeyPropertyInfo

type AttrSetTypeConstraint TlsCertificatePrivateKeyPropertyInfo = * ~ ByteString

type AttrAllowedOps TlsCertificatePrivateKeyPropertyInfo

type AttrAllowedOps TlsCertificatePrivateKeyPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrClear ([] AttrOpTag))

constructTlsCertificatePrivateKey :: IsTlsCertificate o => ByteString -> IO (GValueConstruct o)

tlsCertificatePrivateKey :: AttrLabelProxy "privateKey"

privateKeyPem

data TlsCertificatePrivateKeyPemPropertyInfo

Instances

AttrInfo TlsCertificatePrivateKeyPemPropertyInfo

Associated Types

type AttrAllowedOps TlsCertificatePrivateKeyPemPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo :: * -> Constraint

type AttrGetType TlsCertificatePrivateKeyPemPropertyInfo :: *

type AttrLabel TlsCertificatePrivateKeyPemPropertyInfo :: Symbol

type AttrOrigin TlsCertificatePrivateKeyPemPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo o => Proxy * TlsCertificatePrivateKeyPemPropertyInfo -> o -> IO (AttrGetType TlsCertificatePrivateKeyPemPropertyInfo)

attrSet :: (AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo o, AttrSetTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo b) => Proxy * TlsCertificatePrivateKeyPemPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo o => Proxy * TlsCertificatePrivateKeyPemPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo o, AttrSetTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo b) => Proxy * TlsCertificatePrivateKeyPemPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TlsCertificatePrivateKeyPemPropertyInfo

type AttrOrigin TlsCertificatePrivateKeyPemPropertyInfo = TlsCertificate

type AttrLabel TlsCertificatePrivateKeyPemPropertyInfo

type AttrLabel TlsCertificatePrivateKeyPemPropertyInfo = "private-key-pem"

type AttrGetType TlsCertificatePrivateKeyPemPropertyInfo

type AttrGetType TlsCertificatePrivateKeyPemPropertyInfo = ()

type AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo

type AttrBaseTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo = IsTlsCertificate

type AttrSetTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo

type AttrSetTypeConstraint TlsCertificatePrivateKeyPemPropertyInfo = * ~ Text

type AttrAllowedOps TlsCertificatePrivateKeyPemPropertyInfo

type AttrAllowedOps TlsCertificatePrivateKeyPemPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrClear ([] AttrOpTag))

constructTlsCertificatePrivateKeyPem :: IsTlsCertificate o => Text -> IO (GValueConstruct o)

tlsCertificatePrivateKeyPem :: AttrLabelProxy "privateKeyPem"