Changes between Version 1 and Version 2 of WikiStart

Timestamp:

01/27/14 11:17:15 (10 years ago)

Author:

smagi

Comment:

--

WikiStart

@@ -1 @@
-= Welcome to Trac 0.11.2.1 =
+= Clavis: Security, Type-safe URLs for ASP.NET =
 
-Trac is a '''minimalistic''' approach to '''web-based''' management of
-'''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress.
+Clavis is a simple class library for use with ASP.NET. It provides primitives for secure parameter passing between pages, with compiler-verified taint-checking for any insecure parameters. For an overview of the rationale or the operational details behind Clavis, see [http://higherlogics.blogspot.ca/search/label/Clavis the Clavis blog posts].
 
-All aspects of Trac have been designed with the single goal to 
-'''help developers write great software''' while '''staying out of the way'''
-and imposing as little as possible on a team's established process and
-culture.
+You need only understand a few concepts to use Clavis:
 
-As all Wiki pages, this page is editable, this means that you can
-modify the contents of this page simply by using your
-web-browser. Simply click on the "Edit this page" link at the bottom
-of the page. WikiFormatting will give you a detailed description of
-available Wiki formatting commands.
+ 1. IContinuation for specifying page parameter types
+ 1. Unsafe<T> for specifying unsafe/insecure page parameters
+ 1. Continuation.ToUrl overloads for generating URLs from continuations + arguments
+ 1. Continuation.TryParseX for parsing page parameters
 
-"[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created
-a new Trac environment, containing a default set of wiki pages and some sample
-data. This newly created environment also contains 
-[wiki:TracGuide documentation] to help you get started with your project.
+== Typed Page Parameters ==
 
-You can use [wiki:TracAdmin trac-admin] to configure
-[http://trac.edgewall.org/ Trac] to better fit your project, especially in
-regard to ''components'', ''versions'' and ''milestones''. 
-
-
-TracGuide is a good place to start.
-
-Enjoy! [[BR]]
-''The Trac Team''
-
-== Starting Points ==
-
- * TracGuide --  Built-in Documentation
- * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
- * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
- * TracSupport --  Trac Support
-
-For a complete list of local wiki pages, see TitleIndex.
+A typed page parameter list is specified via an IContinuation<...> declaration, like so:
+{{{
+public class SomePage : System.Web.Page, IContinuation<int, string>
+{
+  ...
+}
+}}}
+This declares a page that accepts a protected Int32 as the first argument, and a protected string as the second argument. By default, all types specified in an IContinuation<...> declaration will be protected, which means they cannot be changed by clients. If you wish to declare that a certain page parameter is unprotected, then you need only wrap it with Unsafe<T>. For instance, suppose the integer argument from the above example should be unprotected:
+{{{
+public class SomePage : System.Web.Page, IContinuation<Unsafe<int>, string>
+{
+  ...
+}
+}}}
+Any type can appear as an argument to IContinuation<...>, not just primitive values. In fact, it's good practice in Clavis not to use primitive types since parameter names are generated from the class name by default:
+{{{
+public class SomePage : System.Web.Page, IContinuation<Unsafe<Project>, Customer>
+{
+  ...
+}
+}}}
+Clavis can also handle lists of values by specifying IEnumerable<T> as a parameter type:
+{{{
+public class SomePage : System.Web.Page, IContinuation<IEnumerable<Project>, Customer>
+{
+  ...
+}
+}}}
+IEnumerable<T> and Unsafe<T> can also be nested, so you can have an unsafe list of objects as a parameter:
+{{{
+public class SomePage : System.Web.Page, IContinuation<Unsafe<IEnumerable<Project>>, Customer>
+{
+  ...
+}
+}}}