概述
jetty的强大之处在于可以自由的配置某些组建的存在与否，以提升性能，减少复杂度，而其本身也因为这种特性而具有很强的可扩展性。securityhandler就是jetty对servlet中security框架部分的实现，并可以根据实际需要装卸和替换。servlet的安全框架主要有两个部分：数据传输的安全以及数据授权，对数据传输的安全，可以使用ssl对应的connector实现，而对于数据授权安全，servlet定义了一套自己的框架。
servlet的安全框架支持两种方式的验证：首先，是用于登陆的验证，对于定义了role-name的资源都需要进行登陆验证，servlet支持none、basic、client-cert、digest、form等5种验证方式(
/)；除了用户登陆验证，servlet框架还定义了role的概念，一个role可以包含一个或多个用户，一个用户可以隶属于多个role，一个资源可以有一个或多个role，只有这些定义的role才能访问该资源，用户只能访问它所隶属的role能访问的资源。另外，对一个servlet来说，还可以定义role-name到role-link的映射关系，从文档上，这里的role-name是servlet中使用的名字，而role-link是container中使用的名字，感觉很模糊，从jetty的角度，role-name是web.xml中在//中对一个url pattern的role定义，而role-link则是useridentity中roles数组的值，而useridentity是loginservice中创建的，它从文件、数据库等加载已定义的user的信息：用户名、密码、它隶属的role等，如果servlet中没有定义role-name到role-link的映射，则直接使用role-name去useridentity中比较role信息。
关于servlet对security框架的具体解释，可以参考oracle的文档：
在web.xml中，对用于登陆验证方式的定义如下：
<login-config>
<auth-method>formauth-method>
<realm-name>example-based authentiation arearealm-name>
<form-login-config>
<form-login-page>/jsp/security/protected/login.jspform-login-page>
<form-error-page>/jsp/security/protected/error.jspform-error-page>
form-login-config>
login-config>
or
<login-config>
<auth-method>basicauth-method>
<realm-name>tomcat manager applicationrealm-name>
login-config>
而对资源所属role的定义如下：
<security-constraint>
<security-constraint>
<web-resource-collection>
<web-resource-name>status interfaceweb-resource-name>
<url-pattern>/status/*url-pattern>
web-resource-collection>
...
<auth-constraint>
<role-name>manager-guirole-name>
<role-name>manager-scriptrole-name>
<role-name>manager-jmxrole-name>
<role-name>manager-statusrole-name>
auth-constraint>
security-constraint>
jetty对servlet security实现概述和类图
在jetty中，使用authenticator接口抽象不同用户登陆验证的逻辑；使用loginservice接口抽象对用户名、密码的验证；使用useridentity保存内部定义的一个用户的用户名、密码、role集合；使用constraintmapping保存url pattern到role集合的映射；使用useridentity.scope保存一个servlet中role-name到role-link的映射。他们的类图如下：
useridentity实现
useridentity表示一个用户的认证信息，它包含subject和userprincipal，其中subject是java security框架定义的类型，而userprincipal则用于存储用户名以及认证信息，在jetty中一般使用knownuser来存储，它包含了username以及credential实例，其中credential可以是crypt、md5、password等。在credential中定义了check方法用于验证传入的credential是否是正确的。
identityservice实现
identityservice我猜原本用于将useridentity、runastoken和当前thread关联在一起，以及创建useridentity、runastoken，然而我看的版本中，defaultidentityservice貌似还没有实现完成，目前只是根据提供的subject、principal、roles创建defaultuseridentity实例，以及使用runasname创建rolerunastoken，对servlet中的runastoken，我看的jetty版本也还没有实现完成。
public useridentity newuseridentity(final subject subject, final principal userprincipal, final string[] roles) {
return new defaultuseridentity(subject,userprincipal,roles);
}
public runastoken newrunastoken(string runasname) {
return new rolerunastoken(runasname);
}
loginservice实现
在jetty中，loginservice用来验证给定的用户名和证书信息(如密码)，即对应的login方法；以及验证给定的useridentity，即对应的validate方法；其name属性用于标识实例本身(即作为当前使用的realm name)；另外identityservice用于根据加载的用户名和证书信息创建useridentity实例。
public interface loginservice {
string getname();
useridentity login(string username,object credentials);
boolean validate(useridentity user);
identityservice getidentityservice();
void setidentityservice(identityservice service);
void logout(useridentity user);
}
为了验证用户提供的用户名和证书的正确性和合法性，需要有一个地方用来存储定义好的正确的用户名以及对应的证书信息(如密码等)，jetty提供了db、properties文件、jaas、spnego作为用户信息源的比较。对于db或properties文件方式存储用户信息，如果每次的验证都去查询数据库或读取文件内容，效率会很低，因而还有一种实现方式是将数据库或文件中定义的用户信息预先的加载到内存中，这样每次验证只需要读取内存即可，这种方式的实现性能会提高很多，但是这样就无法动态的修改用户信息，并且如果用户信息很多，会占用很多的内存，目前jetty采用后者实现，其中数据库存储用户信息有两个：jdbcloginservice以及datasourceloginservice，properties文件存储对应的实现是hashloginservice，它们都继承自mappedloginservice。在mappedloginservice中保存了一个concurrentmap实例，它是一个username到useridentity的映射，在该实例start时，它会从底层的数据源中加载用户信息，对hashloginservice，它会从config指定的properties文件中加载用户信息，并填充concurrentmap，其中properties文件的格式为：=credential, role1, role2, ....如果credential以"md5:"开头，表示它是md5数据，如果以"crypt:"开头，表示它是crypt数据，否则表示它是密码字符；如果以存在的用户不在新读取的用户列表中，则将其移除，因为hashloginservice还可以启动一个线程以隔一定的时间重新加载文件中的内容，以处理文件更新的问题。在mappedloginservice中还定义了几个principal的实现类：knownuser、roleprincipal、anonymous等，在添加加载的用户时，使用knownuser保存username和credential信息，并将该principal添加到subject的principals集合中，同时对每个role创建roleprincipal，并添加到subject的principals集合中，而将credential添加到subject的privatecredentials集合中，使用identityservice创建useridentity，并添加到concurrentmap中。在login验证中，首先使用传入的username查找存在的useridentity，并使用找到的useridentity中的principal的check方法验证传入的credential，如果验证失败，返回null(即调用credential的check方法：password/md5/crypt)。对datasourceloginservice和jdbcloginservice只是从数据库中加载用户信息，不详述。而jaasloginservice和spnegologinservice也只是使用各自的协议进行验证，不细述。
authenticator实现
authenticator用于验证传入的servletrequest、servletresponse是否包含正确的认证信息。其接口定义如下：
public interface authenticator {
// jetty支持basic、form、digest、client_cert、spnego的认证，该方法返回其中的一种，或用于自定义的方法。
string getauthmethod();
// 设置配置信息(securityhandler继承自authconfiguration接口)：authmethod、realmname、initparameters、loginservice、identityservice、issessionrenewedonauthentication
void setconfiguration(authconfiguration configuration);
// 验证逻辑的实现方法，其中mandatory若为false表示当前资源有没有配置role信息，或者@servletsecurity中的@httpconstraint的emptyrolesemantic被配置为permit，此时返回deferred类型的authentication，如果不手动的调用其authenticate或login方法，就不会对该请求进行验证。
// 对basicauthenticator的实现，它从authorization请求头中获取认证信息(用户名和用户密码，使用":"分割，并且使用base64编码)，调用loginservice进行认证，当认证通过时，如果配置了renewsession为true，则将httpsession中的所有属性更新一遍，并且添加(org.eclipse.jetty.security.secured, true) entry，并使用useridentity以及authmethod创建userauthentication返回。如果认证失败，则返回401 unauthorized错误，并且在相应消息中包含头：www-authenticate: basic realm=
// 对formauthenticator的实现，它首先要配置formloginpage、formloginpath(默认j_security_check)、formerrorpage、formerrorpath；只有当前请求url是formloginpath时，从j_username和j_password请求参数中获取username和password信息，使用loginservice验证，如果验证通过且这个请求是因为之前请求其他资源重定向过来的，这重定向到之前的url，创建一个sessionauthentication放入httpsession中，并返回一个新创建的formauthentication；如果验证失败，如果没定义formerrorpage，返回403 forbidden相应，否则重定向或forward到formerrorpage；对于其他url请求，查看在当前session中是否存在已认证的authentication，如果有，但是重新验证缓存的authentication失败，则将这个authentication从httpsession中移除；否则返回这个session中的authentication；对于其他情况，表示当前请求需要认证后才能访问，此时保存当前请求uri以及post数据到session中，以在认证之后可以直接跳转，然后重定向或forward到formloginpage中。
// 对digestauthenticator的实现类似basicauthenticator，只是它使用digest的方式对认证数据进行加密和解密。
// 对clientcertauthenticator则采用客户端证书的方式认证，spnegoauthenticator使用spnego方式认证，jaspiauthenticator使用jaspi方式认证。
authentication validaterequest(servletrequest request, servletresponse response, boolean mandatory) throws serverauthexception;
// 只用于jaspiauthenticator，用于所有后继handler处理完成后对servletrequest、servletresponse、user的进一步处理，目前不了解jaspi的协议逻辑，因而不了解具体的用途。
boolean secureresponse(servletrequest request, servletresponse response, boolean mandatory, user validateduser) throws serverauthexception;
}
securityhandler与constraintsecurityhandler实现
securityhandler继承自handlerwrapper，并实现了authenticator.authconfiguration接口，因而它包含了realm、authmethod、initparameters、loginservice、identityservice、renewsession等字段，在其start时，它会首先从servletcontext的initparameters中导入org.eclipse.jetty.security.*属性的值到其initparameters中，如果loginservice为null，则从server中查找一个已经注册的loginservice，使用authenticator.factory根据authmethod创建对应的authenticator实例。
constraintsecurityhandler继承自securityhandler类，它定义了constraintmapping列表、所有定义的role、以及pathspec到map(key为httpmethod，roleinfo包含userdataconstraint枚举类型和roles集合)的映射，其中constraintmapping中保存了method、methodomissions、pathspec、constraint(constraint中包含了name、roles、dataconstraint等信息)，constraintmapping在解析web.xml文件时添加，它对应下的配置，如auth-constraint下的role-name配置对应roles数组，user-data-contraint对应dataconstraint，web-resource-name对应name，http-method对应method，url-pattern对应pathspec；在每次添加constraintmapping时都会更新roles列表以及pathspec到map的映射。
在securityhandler的handle方法中，它只需要对request、async类型的dispatchertype需要验证：它首先根据pathincontext和request实例查找roleinfo信息；如果roleinfo处于forbidden状态，发送403 forbidden相应，如果dataconstraint配置了intergal、confidential，但是connector中没有配置相应的port，则发送403 forbidden相应，否则重定向请求到integral、confidential对应的url；对没有验证过的请求调用authenticator.validaterequest()对请求进行验证；如果验证的结果是authentication.responsesent，设置request的handled为true，如果为authentication.user，表示认证成功，设置该authentication到request中，并检查role，即检查当前user是否处于roleinfo中的role集合中，如果不是，发送403 forbidden响应，否则调用下一个handler的handle方法，之后调用authenticator.secureresponse()方法；如果验证结果是authentication.deferred，在调用下一个handler的handle方法后调用authenticator.secureresponse()方法；否则直接调用authenticator.secureresponse()方法。
posted on 2014-05-18 22:02
dlevin 阅读(3247)
评论(2) 所属分类:
jetty