Copyright	© Herbert Valerio Riedel 2020
License	GPL-2.0-or-later
Safe Haskell	Trustworthy
Language	Haskell2010

LDAPv3.ASN1String

Contents

Convenience Sum-type
UTF8String
UniversalString
BMPString
IA5String
VisibleString
PrintableString
NumericString

Description

ASN.1 String Types

This modules features types and associated functions for encodingdecoding common ASN.1 string types from their ASN.1 BER representation according to their standard universal/ ASN.1 tag number.

Since: 0.1.1

Synopsis

class ASN1String a where
- asn1string'decode :: ByteString -> Maybe a
- asn1string'encode :: a -> ByteString
- asn1string'supportsCodePoint :: Proxy a -> Char -> Bool
- asn1string'toCodePoints :: a -> [Char]
- asn1string'fromCodePoints :: [Char] -> Maybe a
data ASN1StringChoice
- = ASN1String'OCTET_STRING ShortByteString
- | ASN1String'UniversalString UniversalString
- | ASN1String'UTF8String ShortText
- | ASN1String'BMPString BMPString
- | ASN1String'IA5String IA5String
- | ASN1String'VisibleString VisibleString
- | ASN1String'PrintableString PrintableString
- | ASN1String'NumericString NumericString
asn1StringChoice'encode :: ASN1StringChoice -> ByteString
asn1StringChoice'decode :: ByteString -> Maybe ASN1StringChoice
newtype UTF8String = UTF8String {
- utf8String'toShortText :: ShortText
}
data UniversalString
data BMPString
bmpString'toUcs2CodePoints :: BMPString -> [Word16]
bmpString'fromUcs2CodePoints :: [Word16] -> BMPString
data IA5String
ia5String'toShortText :: IA5String -> ShortText
ia5String'fromShortText :: ShortText -> Maybe IA5String
data VisibleString
visibleString'toShortText :: VisibleString -> ShortText
visibleString'fromShortText :: ShortText -> Maybe VisibleString
data PrintableString
printableString'toShortText :: PrintableString -> ShortText
printableString'fromShortText :: ShortText -> Maybe PrintableString
data NumericString
numericString'toShortText :: NumericString -> ShortText
numericString'fromShortText :: ShortText -> Maybe NumericString

Documentation

class ASN1String a where Source #

Typeclass abstracting over common ASN.1 string operations

Since: 0.1.1

Minimal complete definition

asn1string'supportsCodePoint, asn1string'toCodePoints, asn1string'fromCodePoints

Methods

asn1string'decode :: ByteString -> Maybe a Source #

Decode ASN.1 string type from its ASN.1 BER encoding

default asn1string'decode :: ASN1 a => ByteString -> Maybe a Source #

asn1string'encode :: a -> ByteString Source #

Encode ASN.1 string type to its ASN.1 BER encoding

default asn1string'encode :: ASN1 a => a -> ByteString Source #

asn1string'supportsCodePoint :: Proxy a -> Char -> Bool Source #

Predicate for determining whether given code-point is allowed by the respective ASN.1 string type

asn1string'toCodePoints :: a -> [Char] Source #

Convert ASN.1 string type to list of code-points

asn1string'fromCodePoints :: [Char] -> Maybe a Source #

Construct ASN.1 string type from list of code-points

This returns Nothing if a code-point cannot be expressed in the respective ASN.1 string type.

Instances

Instances details

ASN1String UniversalString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe UniversalString Source # asn1string'encode :: UniversalString -> ByteString Source # asn1string'supportsCodePoint :: Proxy UniversalString -> Char -> Bool Source # asn1string'toCodePoints :: UniversalString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe UniversalString Source #
ASN1String BMPString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe BMPString Source # asn1string'encode :: BMPString -> ByteString Source # asn1string'supportsCodePoint :: Proxy BMPString -> Char -> Bool Source # asn1string'toCodePoints :: BMPString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe BMPString Source #
ASN1String IA5String Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe IA5String Source # asn1string'encode :: IA5String -> ByteString Source # asn1string'supportsCodePoint :: Proxy IA5String -> Char -> Bool Source # asn1string'toCodePoints :: IA5String -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe IA5String Source #
ASN1String VisibleString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe VisibleString Source # asn1string'encode :: VisibleString -> ByteString Source # asn1string'supportsCodePoint :: Proxy VisibleString -> Char -> Bool Source # asn1string'toCodePoints :: VisibleString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe VisibleString Source #
ASN1String NumericString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe NumericString Source # asn1string'encode :: NumericString -> ByteString Source # asn1string'supportsCodePoint :: Proxy NumericString -> Char -> Bool Source # asn1string'toCodePoints :: NumericString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe NumericString Source #
ASN1String PrintableString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe PrintableString Source # asn1string'encode :: PrintableString -> ByteString Source # asn1string'supportsCodePoint :: Proxy PrintableString -> Char -> Bool Source # asn1string'toCodePoints :: PrintableString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe PrintableString Source #
ASN1String UTF8String Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe UTF8String Source # asn1string'encode :: UTF8String -> ByteString Source # asn1string'supportsCodePoint :: Proxy UTF8String -> Char -> Bool Source # asn1string'toCodePoints :: UTF8String -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe UTF8String Source #

Convenience Sum-type

data ASN1StringChoice Source #

Convenient Sum-type combining a subset of the standard ASN.1 string-like types

See specific string types in LDAPv3.ASN1String for details.

Constructors

ASN1String'OCTET_STRING ShortByteString
ASN1String'UniversalString UniversalString
ASN1String'UTF8String ShortText
ASN1String'BMPString BMPString
ASN1String'IA5String IA5String
ASN1String'VisibleString VisibleString
ASN1String'PrintableString PrintableString
ASN1String'NumericString NumericString

Instances

Instances details

Eq ASN1StringChoice Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: ASN1StringChoice -> ASN1StringChoice -> Bool # (/=) :: ASN1StringChoice -> ASN1StringChoice -> Bool #
Show ASN1StringChoice Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> ASN1StringChoice -> ShowS # show :: ASN1StringChoice -> String # showList :: [ASN1StringChoice] -> ShowS #
Binary ASN1StringChoice Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: ASN1StringChoice -> Put # get :: Get ASN1StringChoice # putList :: [ASN1StringChoice] -> Put #

asn1StringChoice'encode :: ASN1StringChoice -> ByteString Source #

Encode ASN.1 string choice to its ASN.1 BER encoding

Since: 0.1.1

asn1StringChoice'decode :: ByteString -> Maybe ASN1StringChoice Source #

Decode ASN.1 string choice from its ASN.1 BER encoding

Since: 0.1.1

UTF8String

newtype UTF8String Source #

ASN.1 UTF8String

UTF8String ::= [UNIVERSAL 12] IMPLICIT OCTET STRING

Since: 0.1.1

Constructors

UTF8String
Fields utf8String'toShortText :: ShortText

Instances

Instances details

Eq UTF8String Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: UTF8String -> UTF8String -> Bool # (/=) :: UTF8String -> UTF8String -> Bool #
Ord UTF8String Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: UTF8String -> UTF8String -> Ordering # (<) :: UTF8String -> UTF8String -> Bool # (<=) :: UTF8String -> UTF8String -> Bool # (>) :: UTF8String -> UTF8String -> Bool # (>=) :: UTF8String -> UTF8String -> Bool # max :: UTF8String -> UTF8String -> UTF8String # min :: UTF8String -> UTF8String -> UTF8String #
Show UTF8String Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> UTF8String -> ShowS # show :: UTF8String -> String # showList :: [UTF8String] -> ShowS #
Binary UTF8String Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: UTF8String -> Put # get :: Get UTF8String # putList :: [UTF8String] -> Put #
ASN1String UTF8String Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe UTF8String Source # asn1string'encode :: UTF8String -> ByteString Source # asn1string'supportsCodePoint :: Proxy UTF8String -> Char -> Bool Source # asn1string'toCodePoints :: UTF8String -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe UTF8String Source #

UniversalString

data UniversalString Source #

ASN.1 UniversalString

UniversalString ::= [UNIVERSAL 28] IMPLICIT OCTET STRING

NB: The surrogate-pair range U+D800 through U+DFFF is tolerated and thus becomes the responsibility of code converting to and from UniversalString

Since: 0.1.1

Instances

Instances details

Eq UniversalString Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: UniversalString -> UniversalString -> Bool # (/=) :: UniversalString -> UniversalString -> Bool #
Ord UniversalString Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: UniversalString -> UniversalString -> Ordering # (<) :: UniversalString -> UniversalString -> Bool # (<=) :: UniversalString -> UniversalString -> Bool # (>) :: UniversalString -> UniversalString -> Bool # (>=) :: UniversalString -> UniversalString -> Bool # max :: UniversalString -> UniversalString -> UniversalString # min :: UniversalString -> UniversalString -> UniversalString #
Show UniversalString Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> UniversalString -> ShowS # show :: UniversalString -> String # showList :: [UniversalString] -> ShowS #
Binary UniversalString Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: UniversalString -> Put # get :: Get UniversalString # putList :: [UniversalString] -> Put #
ASN1String UniversalString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe UniversalString Source # asn1string'encode :: UniversalString -> ByteString Source # asn1string'supportsCodePoint :: Proxy UniversalString -> Char -> Bool Source # asn1string'toCodePoints :: UniversalString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe UniversalString Source #

BMPString

data BMPString Source #

ASN.1 BMPString

BMPString ::= [UNIVERSAL 30] IMPLICIT OCTET STRING

NB: The surrogate-pair range U+D800 through U+DFFF is tolerated and thus the responsibility of code converting to and from BMPString

Since: 0.1.1

Instances

Instances details

Eq BMPString Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: BMPString -> BMPString -> Bool # (/=) :: BMPString -> BMPString -> Bool #
Ord BMPString Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: BMPString -> BMPString -> Ordering # (<) :: BMPString -> BMPString -> Bool # (<=) :: BMPString -> BMPString -> Bool # (>) :: BMPString -> BMPString -> Bool # (>=) :: BMPString -> BMPString -> Bool # max :: BMPString -> BMPString -> BMPString # min :: BMPString -> BMPString -> BMPString #
Show BMPString Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> BMPString -> ShowS # show :: BMPString -> String # showList :: [BMPString] -> ShowS #
Binary BMPString Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: BMPString -> Put # get :: Get BMPString # putList :: [BMPString] -> Put #
ASN1String BMPString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe BMPString Source # asn1string'encode :: BMPString -> ByteString Source # asn1string'supportsCodePoint :: Proxy BMPString -> Char -> Bool Source # asn1string'toCodePoints :: BMPString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe BMPString Source #

bmpString'toUcs2CodePoints :: BMPString -> [Word16] Source #

bmpString'fromUcs2CodePoints :: [Word16] -> BMPString Source #

IA5String

data IA5String Source #

ASN.1 IA5String

IA5String ::= [UNIVERSAL 22] IMPLICIT OCTET STRING

Since: 0.1.1

Instances

Instances details

Eq IA5String Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: IA5String -> IA5String -> Bool # (/=) :: IA5String -> IA5String -> Bool #
Ord IA5String Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: IA5String -> IA5String -> Ordering # (<) :: IA5String -> IA5String -> Bool # (<=) :: IA5String -> IA5String -> Bool # (>) :: IA5String -> IA5String -> Bool # (>=) :: IA5String -> IA5String -> Bool # max :: IA5String -> IA5String -> IA5String # min :: IA5String -> IA5String -> IA5String #
Show IA5String Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> IA5String -> ShowS # show :: IA5String -> String # showList :: [IA5String] -> ShowS #
Binary IA5String Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: IA5String -> Put # get :: Get IA5String # putList :: [IA5String] -> Put #
ASN1String IA5String Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe IA5String Source # asn1string'encode :: IA5String -> ByteString Source # asn1string'supportsCodePoint :: Proxy IA5String -> Char -> Bool Source # asn1string'toCodePoints :: IA5String -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe IA5String Source #

ia5String'toShortText :: IA5String -> ShortText Source #

ia5String'fromShortText :: ShortText -> Maybe IA5String Source #

VisibleString

data VisibleString Source #

ASN.1 VisibleString

VisibleString ::= [UNIVERSAL 26] IMPLICIT OCTET STRING

Since: 0.1.1

Instances

Instances details

Eq VisibleString Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: VisibleString -> VisibleString -> Bool # (/=) :: VisibleString -> VisibleString -> Bool #
Ord VisibleString Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: VisibleString -> VisibleString -> Ordering # (<) :: VisibleString -> VisibleString -> Bool # (<=) :: VisibleString -> VisibleString -> Bool # (>) :: VisibleString -> VisibleString -> Bool # (>=) :: VisibleString -> VisibleString -> Bool # max :: VisibleString -> VisibleString -> VisibleString # min :: VisibleString -> VisibleString -> VisibleString #
Show VisibleString Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> VisibleString -> ShowS # show :: VisibleString -> String # showList :: [VisibleString] -> ShowS #
Binary VisibleString Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: VisibleString -> Put # get :: Get VisibleString # putList :: [VisibleString] -> Put #
ASN1String VisibleString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe VisibleString Source # asn1string'encode :: VisibleString -> ByteString Source # asn1string'supportsCodePoint :: Proxy VisibleString -> Char -> Bool Source # asn1string'toCodePoints :: VisibleString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe VisibleString Source #

visibleString'toShortText :: VisibleString -> ShortText Source #

visibleString'fromShortText :: ShortText -> Maybe VisibleString Source #

PrintableString

data PrintableString Source #

ASN.1 PrintableString

PrintableString ::= [UNIVERSAL 19] IMPLICIT OCTET STRING

Since: 0.1.1

Instances

Instances details

Eq PrintableString Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: PrintableString -> PrintableString -> Bool # (/=) :: PrintableString -> PrintableString -> Bool #
Ord PrintableString Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: PrintableString -> PrintableString -> Ordering # (<) :: PrintableString -> PrintableString -> Bool # (<=) :: PrintableString -> PrintableString -> Bool # (>) :: PrintableString -> PrintableString -> Bool # (>=) :: PrintableString -> PrintableString -> Bool # max :: PrintableString -> PrintableString -> PrintableString # min :: PrintableString -> PrintableString -> PrintableString #
Show PrintableString Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> PrintableString -> ShowS # show :: PrintableString -> String # showList :: [PrintableString] -> ShowS #
Binary PrintableString Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: PrintableString -> Put # get :: Get PrintableString # putList :: [PrintableString] -> Put #
ASN1String PrintableString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe PrintableString Source # asn1string'encode :: PrintableString -> ByteString Source # asn1string'supportsCodePoint :: Proxy PrintableString -> Char -> Bool Source # asn1string'toCodePoints :: PrintableString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe PrintableString Source #

printableString'toShortText :: PrintableString -> ShortText Source #

printableString'fromShortText :: ShortText -> Maybe PrintableString Source #

NumericString

data NumericString Source #

ASN.1 NumericString

NumericString ::= [UNIVERSAL 18] IMPLICIT OCTET STRING

Since: 0.1.1

Instances

Instances details

Eq NumericString Source #
Instance details Defined in LDAPv3.ASN1String Methods (==) :: NumericString -> NumericString -> Bool # (/=) :: NumericString -> NumericString -> Bool #
Ord NumericString Source #
Instance details Defined in LDAPv3.ASN1String Methods compare :: NumericString -> NumericString -> Ordering # (<) :: NumericString -> NumericString -> Bool # (<=) :: NumericString -> NumericString -> Bool # (>) :: NumericString -> NumericString -> Bool # (>=) :: NumericString -> NumericString -> Bool # max :: NumericString -> NumericString -> NumericString # min :: NumericString -> NumericString -> NumericString #
Show NumericString Source #
Instance details Defined in LDAPv3.ASN1String Methods showsPrec :: Int -> NumericString -> ShowS # show :: NumericString -> String # showList :: [NumericString] -> ShowS #
Binary NumericString Source #	Encodes as ASN.1 BER
Instance details Defined in LDAPv3.ASN1String Methods put :: NumericString -> Put # get :: Get NumericString # putList :: [NumericString] -> Put #
ASN1String NumericString Source #
Instance details Defined in LDAPv3.ASN1String Methods asn1string'decode :: ByteString -> Maybe NumericString Source # asn1string'encode :: NumericString -> ByteString Source # asn1string'supportsCodePoint :: Proxy NumericString -> Char -> Bool Source # asn1string'toCodePoints :: NumericString -> [Char] Source # asn1string'fromCodePoints :: [Char] -> Maybe NumericString Source #

numericString'toShortText :: NumericString -> ShortText Source #

numericString'fromShortText :: ShortText -> Maybe NumericString Source #