Difference between revisions of "HSL"

From Halon, SMTP software for hosting providers
Jump to: navigation, search
(Functions and contexts)
Line 5: Line 5:
 
The '''Halon Scripting Language''' ('''HSL''') is an email-centric, [https://en.wikipedia.org/wiki/Domain-specific_language domain-specific] language that's at the core of the {{HalonProdName}}.
 
The '''Halon Scripting Language''' ('''HSL''') is an email-centric, [https://en.wikipedia.org/wiki/Domain-specific_language domain-specific] language that's at the core of the {{HalonProdName}}.
  
The language itself implements a set of [[HSL core functions|standard library]] functions. In addition to that, there are ''contexts'' (or extensions) that are implemented by the different [https://en.wikipedia.org/wiki/Daemon_(computing) daemon processes]; such as [[HSL System Authentication|API authentication]], [[HSL IP Policy|IP firewall]] and most importantly the e-mail oriented flows that maps to SMTP commands; [[HSL Mail Authentication|AUTH]] (SASL), [[HSL Mail Recipient|RCPT TO]], [[HSL Mail Content|DATA]] and queue processing [[HSL Mail Queue|pre-]] and [[HSL Mail Transport|post-]] delivery. The contexts define additional functions, as well as pre-defined variables.
+
The language itself implements a set of [[HSL core functions|standard library]] functions. In addition to that, there are ''contexts'' (or extensions) that are implemented by the different [https://en.wikipedia.org/wiki/Daemon_(computing) daemon processes]; such as [[HSL System Authentication|API authentication]], [[HSL IP Policy|IP firewall]] and most importantly the e-mail oriented flows that maps to SMTP commands; [[HSL Mail Authentication|AUTH]] (SASL), [http://docs.halon.se/hsl/mailfrom.html MAIL FROM], [[HSL Mail Recipient|RCPT TO]], [[HSL Mail Content|DATA]] and queue processing [[HSL Mail Queue|pre-]] and [[HSL Mail Transport|post-]] delivery. The contexts define additional functions, as well as pre-defined variables.
  
 
Although the syntax and function names in HSL are very much similar to PHP, Python, Perl and C, it's important to remember that HSL is a completely different language. There are syntax differences, and the performance characteristics of different coding styles are not comparable between these languages.
 
Although the syntax and function names in HSL are very much similar to PHP, Python, Perl and C, it's important to remember that HSL is a completely different language. There are syntax differences, and the performance characteristics of different coding styles are not comparable between these languages.
Line 26: Line 26:
 
| [[HSL Mail Authentication|AUTH]] || <tt>smtpd</tt> || Handling SMTP AUTH (SASL) requests  
 
| [[HSL Mail Authentication|AUTH]] || <tt>smtpd</tt> || Handling SMTP AUTH (SASL) requests  
 
|-
 
|-
| [[HSL Mail Recipient|RCPT TO]] || <tt>smtpd</tt> || Handling the SMTP MAIL FROM and RCPT TO commands
+
| [http://docs.halon.se/hsl/mailfrom.html MAIL FROM] || <tt>smtpd</tt> || Handling the SMTP MAIL FROM commands
 +
|-
 +
| [[HSL Mail Recipient|RCPT TO]] || <tt>smtpd</tt> || Handling the SMTP RCPT TO commands
 
|-
 
|-
 
| [[HSL Mail Content|DATA]] || <tt>smtpd</tt> || Handling the SMTP DATA command; in other words "the mail message"
 
| [[HSL Mail Content|DATA]] || <tt>smtpd</tt> || Handling the SMTP DATA command; in other words "the mail message"

Revision as of 08:50, 31 May 2017

The scripting language is documented in the HSL reference manual.
At its core, Halon is a scriptable SMTP server

The Halon Scripting Language (HSL) is an email-centric, domain-specific language that's at the core of the Halon platform.

The language itself implements a set of standard library functions. In addition to that, there are contexts (or extensions) that are implemented by the different daemon processes; such as API authentication, IP firewall and most importantly the e-mail oriented flows that maps to SMTP commands; AUTH (SASL), MAIL FROM, RCPT TO, DATA and queue processing pre- and post- delivery. The contexts define additional functions, as well as pre-defined variables.

Although the syntax and function names in HSL are very much similar to PHP, Python, Perl and C, it's important to remember that HSL is a completely different language. There are syntax differences, and the performance characteristics of different coding styles are not comparable between these languages.

Functions and contexts

Standard library functions are recognised by their lowercase names, and can be used in any context. Most functions are indeed standard library functions, for reusability. The other (context) functions, such as Reject($msg) (giving a 500 SMTP error), have capitalized names.

Below is a table relating functions and SMTP commands to HSL contexts

Context Process Description
Standard library all processes Shared among all contexts
IP smtpd Handling IP packets, like a scripted firewall
AUTH smtpd Handling SMTP AUTH (SASL) requests
MAIL FROM smtpd Handling the SMTP MAIL FROM commands
RCPT TO smtpd Handling the SMTP RCPT TO commands
DATA smtpd Handling the SMTP DATA command; in other words "the mail message"
Pre-delivery mailqueued Decides what is to be done before a delivery is attempted
Post-delivery mailqueued Decides what is to be done when a delivery attempt is done
API authentication backend Handling administration (SOAP API) sign-ins, suitable for RADIUS/TACACS+ integration