annotate src/ur/openidUser.urs @ 25:c560ec5bf514

More flexibility in placement of login form and other similar stuff
author Adam Chlipala <adam@chlipala.net>
date Thu, 20 Jan 2011 12:23:44 -0500
parents e5df3d3554d3
children ee97bc0e08fa
rev   line source
adam@18 1 (* This module provides generic user authentication functionality, backed by
adam@18 2 * OpenID authentication. Each account (named with a short alphanumeric string)
adam@18 3 * is associated with one or more OpenID identifiers, any of which may be used
adam@18 4 * to log in as that user. This module provides all the code you need to sign
adam@18 5 * users up, log them in, and check which user is logged in.
adam@18 6 *
adam@18 7 * Module author: Adam Chlipala
adam@18 8 *)
adam@18 9
adam@18 10 (* Instantiate this functor to create your customized authentication scheme. *)
adam@16 11 functor Make(M: sig
adam@16 12 con cols :: {Type}
adam@16 13 constraint [Id] ~ cols
adam@17 14 val folder : folder cols
adam@17 15 val inj : $(map sql_injectable cols)
adam@18 16 (* Extra columns of profile information to include in the user
adam@18 17 * database table *)
adam@16 18
adam@17 19 type creationState
adam@18 20 (* The type of client-side state used while soliciting sign-up
adam@18 21 * input *)
adam@17 22 type creationData
adam@18 23 (* A functional representation of the latest client-side state *)
adam@18 24
adam@17 25 val creationState : transaction creationState
adam@18 26 (* Create some fresh client-side state. *)
adam@18 27
adam@17 28 val render : creationState -> xtable
adam@18 29 (* Display widgets. *)
adam@18 30
adam@20 31 val ready : creationState -> signal bool
adam@20 32 (* Is the data ready to send? *)
adam@20 33
adam@17 34 val tabulate : creationState -> signal creationData
adam@18 35 (* Functionalize current state. *)
adam@18 36
adam@18 37 val choose : sql_table ([Id = string] ++ cols) [Pkey = [Id]]
adam@18 38 -> creationData -> transaction $cols
adam@18 39 (* Use functionalized state to choose initial column values,
adam@18 40 * given a handle to the users table. *)
adam@17 41
adam@16 42 val sessionLifetime : int
adam@16 43 (* Number of seconds a session may live *)
adam@16 44
adam@16 45 val afterLogout : url
adam@16 46 (* Where to send the user after he logs out *)
adam@16 47
adam@16 48 val secureCookies : bool
adam@18 49 (* Should authentication cookies be restricted to SSL
adam@18 50 * connections? *)
adam@16 51
adam@16 52 val association : Openid.association_mode
adam@16 53 (* OpenID cryptography preferences *)
adam@16 54
adam@16 55 val realm : option string
adam@18 56 (* See end of [Openid] module's documentation for the meaning
adam@18 57 * of realms. *)
adam@17 58
adam@17 59 val formClass : css_class
adam@18 60 (* CSS class for <table>, <th>, and <td> elements used in
adam@18 61 * sign-up form *)
adam@23 62
adam@23 63 val fakeId : option string
adam@23 64 (* If set, this string is always accepted as a verified
adam@23 65 * identifier, which can be useful during development (say,
adam@23 66 * when you're off-network). *)
adam@16 67 end) : sig
adam@16 68
adam@16 69 type user
adam@16 70 val show_user : show user
adam@16 71 val inj_user : sql_injectable_prim user
adam@18 72 (* The abstract type of user IDs. It's really [string], but this is only
adam@18 73 * exposed via some standard type class instances. *)
adam@16 74
adam@16 75 table user : ([Id = user] ++ M.cols)
adam@16 76 PRIMARY KEY Id
adam@16 77
adam@16 78 val current : transaction (option user)
adam@18 79 (* Figure out which, if any, user is logged in on this connection. *)
adam@16 80
adam@25 81 val main : (string -> xbody -> transaction page) -> transaction {Status : xbody,
adam@25 82 Other : xbody}
adam@18 83 (* Pass in your generic page template; get out the HTML snippet for user
adam@18 84 * management, suitable for, e.g., inclusion in your standard page
adam@25 85 * header. The output gives a "status" chunk, which will either be a login
adam@25 86 * form or a message about which user is logged in; and an "other" chunk,
adam@25 87 * which will be a log out or sign up link. *)
adam@16 88
adam@16 89 end