Safe Haskell	Safe-Inferred
Language	Haskell2010

Callable

Description

The intermediate language (IL) / intermediate representation (IR) / bitcode are all synonyms for a data structure able to represent code originating from multiple programming languages.
In our context, the main purpose is to enable an efficient and uniform static code analysis, as part of the dhscanner framework for CI/CD container security checks.
dhscanner targets mostly languages used for cloud native applications: Python, Ruby, Php, Javascript, Typescript, Java, C# and Golang.
Typically, a collection of files are first parsed using relevant parsers, then, the resulting abstract syntax trees are sent to code generation, where they are translated into a collection of callables.
A callable is a sequence of commands corresponding to either a function, a method, a lambda or (in languages like python) a script.

Synopsis

data Callables = Callables {
- actualCallables :: [Callable]
}
data Callable
- = Method MethodContent
- | Lambda LambdaContent
- | Script ScriptContent
- | Function FunctionContent
data MethodContent = MethodContent {
- methodName :: MethdName
- hostingClassName :: ClassName
- hostingClassSupers :: [Fqn]
- methodBody :: Cfg
- methodLocation :: Location
}
data LambdaContent = LambdaContent {
- lambdaBody :: Cfg
- lambdaLocation :: Location
}
data ScriptContent = ScriptContent {
- filename :: String
- scriptBody :: Cfg
}
data Annotation = Annotation {
- annotationFqn :: String
- annotationConstantStrings :: [String]
}
data FunctionContent = FunctionContent {
- funcName :: FuncName
- funcBody :: Cfg
- funcAnnotations :: [Annotation]
- funcLocation :: Location
}

Documentation

data Callables Source #

Constructors

Callables
Fields actualCallables :: [Callable]

Instances

Instances details

FromJSON Callables Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser Callables # parseJSONList :: Value -> Parser [Callables] # omittedField :: Maybe Callables #
ToJSON Callables Source #
Instance details Defined in Callable Methods toJSON :: Callables -> Value # toEncoding :: Callables -> Encoding # toJSONList :: [Callables] -> Value # toEncodingList :: [Callables] -> Encoding # omitField :: Callables -> Bool #
Generic Callables Source #
Instance details Defined in Callable Associated Types type Rep Callables :: Type -> Type Methods from :: Callables -> Rep Callables x to :: Rep Callables x -> Callables
Show Callables Source #
Instance details Defined in Callable Methods showsPrec :: Int -> Callables -> ShowS show :: Callables -> String showList :: [Callables] -> ShowS
Eq Callables Source #
Instance details Defined in Callable Methods (==) :: Callables -> Callables -> Bool (/=) :: Callables -> Callables -> Bool
Ord Callables Source #
Instance details Defined in Callable Methods compare :: Callables -> Callables -> Ordering (<) :: Callables -> Callables -> Bool (<=) :: Callables -> Callables -> Bool (>) :: Callables -> Callables -> Bool (>=) :: Callables -> Callables -> Bool max :: Callables -> Callables -> Callables min :: Callables -> Callables -> Callables
type Rep Callables Source #
Instance details Defined in Callable type Rep Callables = D1 ('MetaData "Callables" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) (C1 ('MetaCons "Callables" 'PrefixI 'True) (S1 ('MetaSel ('Just "actualCallables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Callable])))

data Callable Source #

Four kinds of callables.

Constructors

Method MethodContent
Lambda LambdaContent
Script ScriptContent
Function FunctionContent

Instances

Instances details

FromJSON Callable Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser Callable # parseJSONList :: Value -> Parser [Callable] # omittedField :: Maybe Callable #
ToJSON Callable Source #
Instance details Defined in Callable Methods toJSON :: Callable -> Value # toEncoding :: Callable -> Encoding # toJSONList :: [Callable] -> Value # toEncodingList :: [Callable] -> Encoding # omitField :: Callable -> Bool #
Generic Callable Source #
Instance details Defined in Callable Associated Types type Rep Callable :: Type -> Type Methods from :: Callable -> Rep Callable x to :: Rep Callable x -> Callable
Show Callable Source #
Instance details Defined in Callable Methods showsPrec :: Int -> Callable -> ShowS show :: Callable -> String showList :: [Callable] -> ShowS
Eq Callable Source #
Instance details Defined in Callable Methods (==) :: Callable -> Callable -> Bool (/=) :: Callable -> Callable -> Bool
Ord Callable Source #
Instance details Defined in Callable Methods compare :: Callable -> Callable -> Ordering (<) :: Callable -> Callable -> Bool (<=) :: Callable -> Callable -> Bool (>) :: Callable -> Callable -> Bool (>=) :: Callable -> Callable -> Bool max :: Callable -> Callable -> Callable min :: Callable -> Callable -> Callable
type Rep Callable Source #
Instance details Defined in Callable type Rep Callable = D1 ('MetaData "Callable" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) ((C1 ('MetaCons "Method" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MethodContent)) :+: C1 ('MetaCons "Lambda" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LambdaContent))) :+: (C1 ('MetaCons "Script" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptContent)) :+: C1 ('MetaCons "Function" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FunctionContent))))

data MethodContent Source #

Constructors

MethodContent
Fields methodName :: MethdName hostingClassName :: ClassName hostingClassSupers :: [Fqn] methodBody :: Cfg methodLocation :: Location

Instances

Instances details

FromJSON MethodContent Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser MethodContent # parseJSONList :: Value -> Parser [MethodContent] # omittedField :: Maybe MethodContent #
ToJSON MethodContent Source #
Instance details Defined in Callable Methods toJSON :: MethodContent -> Value # toEncoding :: MethodContent -> Encoding # toJSONList :: [MethodContent] -> Value # toEncodingList :: [MethodContent] -> Encoding # omitField :: MethodContent -> Bool #
Generic MethodContent Source #
Instance details Defined in Callable Associated Types type Rep MethodContent :: Type -> Type Methods from :: MethodContent -> Rep MethodContent x to :: Rep MethodContent x -> MethodContent
Show MethodContent Source #
Instance details Defined in Callable Methods showsPrec :: Int -> MethodContent -> ShowS show :: MethodContent -> String showList :: [MethodContent] -> ShowS
Eq MethodContent Source #
Instance details Defined in Callable Methods (==) :: MethodContent -> MethodContent -> Bool (/=) :: MethodContent -> MethodContent -> Bool
Ord MethodContent Source #
Instance details Defined in Callable Methods compare :: MethodContent -> MethodContent -> Ordering (<) :: MethodContent -> MethodContent -> Bool (<=) :: MethodContent -> MethodContent -> Bool (>) :: MethodContent -> MethodContent -> Bool (>=) :: MethodContent -> MethodContent -> Bool max :: MethodContent -> MethodContent -> MethodContent min :: MethodContent -> MethodContent -> MethodContent
type Rep MethodContent Source #
Instance details Defined in Callable type Rep MethodContent = D1 ('MetaData "MethodContent" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) (C1 ('MetaCons "MethodContent" 'PrefixI 'True) ((S1 ('MetaSel ('Just "methodName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MethdName) :: S1 ('MetaSel ('Just "hostingClassName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClassName)) :: (S1 ('MetaSel ('Just "hostingClassSupers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Fqn]) :: (S1 ('MetaSel ('Just "methodBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cfg) :: S1 ('MetaSel ('Just "methodLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Location)))))

data LambdaContent Source #

Constructors

LambdaContent
Fields lambdaBody :: Cfg lambdaLocation :: Location

Instances

Instances details

FromJSON LambdaContent Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser LambdaContent # parseJSONList :: Value -> Parser [LambdaContent] # omittedField :: Maybe LambdaContent #
ToJSON LambdaContent Source #
Instance details Defined in Callable Methods toJSON :: LambdaContent -> Value # toEncoding :: LambdaContent -> Encoding # toJSONList :: [LambdaContent] -> Value # toEncodingList :: [LambdaContent] -> Encoding # omitField :: LambdaContent -> Bool #
Generic LambdaContent Source #
Instance details Defined in Callable Associated Types type Rep LambdaContent :: Type -> Type Methods from :: LambdaContent -> Rep LambdaContent x to :: Rep LambdaContent x -> LambdaContent
Show LambdaContent Source #
Instance details Defined in Callable Methods showsPrec :: Int -> LambdaContent -> ShowS show :: LambdaContent -> String showList :: [LambdaContent] -> ShowS
Eq LambdaContent Source #
Instance details Defined in Callable Methods (==) :: LambdaContent -> LambdaContent -> Bool (/=) :: LambdaContent -> LambdaContent -> Bool
Ord LambdaContent Source #
Instance details Defined in Callable Methods compare :: LambdaContent -> LambdaContent -> Ordering (<) :: LambdaContent -> LambdaContent -> Bool (<=) :: LambdaContent -> LambdaContent -> Bool (>) :: LambdaContent -> LambdaContent -> Bool (>=) :: LambdaContent -> LambdaContent -> Bool max :: LambdaContent -> LambdaContent -> LambdaContent min :: LambdaContent -> LambdaContent -> LambdaContent
type Rep LambdaContent Source #
Instance details Defined in Callable type Rep LambdaContent = D1 ('MetaData "LambdaContent" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) (C1 ('MetaCons "LambdaContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "lambdaBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cfg) :*: S1 ('MetaSel ('Just "lambdaLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Location)))

data ScriptContent Source #

Constructors

ScriptContent
Fields filename :: String scriptBody :: Cfg

Instances

Instances details

FromJSON ScriptContent Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser ScriptContent # parseJSONList :: Value -> Parser [ScriptContent] # omittedField :: Maybe ScriptContent #
ToJSON ScriptContent Source #
Instance details Defined in Callable Methods toJSON :: ScriptContent -> Value # toEncoding :: ScriptContent -> Encoding # toJSONList :: [ScriptContent] -> Value # toEncodingList :: [ScriptContent] -> Encoding # omitField :: ScriptContent -> Bool #
Generic ScriptContent Source #
Instance details Defined in Callable Associated Types type Rep ScriptContent :: Type -> Type Methods from :: ScriptContent -> Rep ScriptContent x to :: Rep ScriptContent x -> ScriptContent
Show ScriptContent Source #
Instance details Defined in Callable Methods showsPrec :: Int -> ScriptContent -> ShowS show :: ScriptContent -> String showList :: [ScriptContent] -> ShowS
Eq ScriptContent Source #
Instance details Defined in Callable Methods (==) :: ScriptContent -> ScriptContent -> Bool (/=) :: ScriptContent -> ScriptContent -> Bool
Ord ScriptContent Source #
Instance details Defined in Callable Methods compare :: ScriptContent -> ScriptContent -> Ordering (<) :: ScriptContent -> ScriptContent -> Bool (<=) :: ScriptContent -> ScriptContent -> Bool (>) :: ScriptContent -> ScriptContent -> Bool (>=) :: ScriptContent -> ScriptContent -> Bool max :: ScriptContent -> ScriptContent -> ScriptContent min :: ScriptContent -> ScriptContent -> ScriptContent
type Rep ScriptContent Source #
Instance details Defined in Callable type Rep ScriptContent = D1 ('MetaData "ScriptContent" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) (C1 ('MetaCons "ScriptContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "scriptBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cfg)))

data Annotation Source #

Constructors

Annotation
Fields annotationFqn :: String annotationConstantStrings :: [String]

Instances

Instances details

FromJSON Annotation Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser Annotation # parseJSONList :: Value -> Parser [Annotation] # omittedField :: Maybe Annotation #
ToJSON Annotation Source #
Instance details Defined in Callable Methods toJSON :: Annotation -> Value # toEncoding :: Annotation -> Encoding # toJSONList :: [Annotation] -> Value # toEncodingList :: [Annotation] -> Encoding # omitField :: Annotation -> Bool #
Generic Annotation Source #
Instance details Defined in Callable Associated Types type Rep Annotation :: Type -> Type Methods from :: Annotation -> Rep Annotation x to :: Rep Annotation x -> Annotation
Show Annotation Source #
Instance details Defined in Callable Methods showsPrec :: Int -> Annotation -> ShowS show :: Annotation -> String showList :: [Annotation] -> ShowS
Eq Annotation Source #
Instance details Defined in Callable Methods (==) :: Annotation -> Annotation -> Bool (/=) :: Annotation -> Annotation -> Bool
Ord Annotation Source #
Instance details Defined in Callable Methods compare :: Annotation -> Annotation -> Ordering (<) :: Annotation -> Annotation -> Bool (<=) :: Annotation -> Annotation -> Bool (>) :: Annotation -> Annotation -> Bool (>=) :: Annotation -> Annotation -> Bool max :: Annotation -> Annotation -> Annotation min :: Annotation -> Annotation -> Annotation
type Rep Annotation Source #
Instance details Defined in Callable type Rep Annotation = D1 ('MetaData "Annotation" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) (C1 ('MetaCons "Annotation" 'PrefixI 'True) (S1 ('MetaSel ('Just "annotationFqn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "annotationConstantStrings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))

data FunctionContent Source #

Constructors

FunctionContent
Fields funcName :: FuncName funcBody :: Cfg funcAnnotations :: [Annotation] funcLocation :: Location

Instances

Instances details

FromJSON FunctionContent Source #
Instance details Defined in Callable Methods parseJSON :: Value -> Parser FunctionContent # parseJSONList :: Value -> Parser [FunctionContent] # omittedField :: Maybe FunctionContent #
ToJSON FunctionContent Source #
Instance details Defined in Callable Methods toJSON :: FunctionContent -> Value # toEncoding :: FunctionContent -> Encoding # toJSONList :: [FunctionContent] -> Value # toEncodingList :: [FunctionContent] -> Encoding # omitField :: FunctionContent -> Bool #
Generic FunctionContent Source #
Instance details Defined in Callable Associated Types type Rep FunctionContent :: Type -> Type Methods from :: FunctionContent -> Rep FunctionContent x to :: Rep FunctionContent x -> FunctionContent
Show FunctionContent Source #
Instance details Defined in Callable Methods showsPrec :: Int -> FunctionContent -> ShowS show :: FunctionContent -> String showList :: [FunctionContent] -> ShowS
Eq FunctionContent Source #
Instance details Defined in Callable Methods (==) :: FunctionContent -> FunctionContent -> Bool (/=) :: FunctionContent -> FunctionContent -> Bool
Ord FunctionContent Source #
Instance details Defined in Callable Methods compare :: FunctionContent -> FunctionContent -> Ordering (<) :: FunctionContent -> FunctionContent -> Bool (<=) :: FunctionContent -> FunctionContent -> Bool (>) :: FunctionContent -> FunctionContent -> Bool (>=) :: FunctionContent -> FunctionContent -> Bool max :: FunctionContent -> FunctionContent -> FunctionContent min :: FunctionContent -> FunctionContent -> FunctionContent
type Rep FunctionContent Source #
Instance details Defined in Callable type Rep FunctionContent = D1 ('MetaData "FunctionContent" "Callable" "dhscanner-bitcode-0.1.0.3-inplace" 'False) (C1 ('MetaCons "FunctionContent" 'PrefixI 'True) ((S1 ('MetaSel ('Just "funcName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FuncName) :: S1 ('MetaSel ('Just "funcBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cfg)) :: (S1 ('MetaSel ('Just "funcAnnotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Annotation]) :*: S1 ('MetaSel ('Just "funcLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Location))))