-
Notifications
You must be signed in to change notification settings - Fork 40
Expand file tree
/
Copy pathServiceStack.xml
More file actions
6998 lines (6958 loc) · 389 KB
/
ServiceStack.xml
File metadata and controls
6998 lines (6958 loc) · 389 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>ServiceStack</name>
</assembly>
<members>
<member name="T:ServiceStack.AppHostBase">
<summary>
Inherit from this class if you want to host your web services inside an
ASP.NET application.
</summary>
</member>
<member name="M:ServiceStack.AppHostExtensions.GetContainer(ServiceStack.IAppHost)">
<summary>
Get an IAppHost container.
Note: Registering dependencies should only be done during setup/configuration
stage and remain immutable there after for thread-safety.
</summary>
<param name="appHost"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.AppHostHttpListenerBase">
<summary>
Inherit from this class if you want to host your web services inside a
Console Application, Windows Service, etc.
Usage of HttpListener allows you to host webservices on the same port (:80) as IIS
however it requires admin user privillages.
</summary>
</member>
<member name="M:ServiceStack.AppHostHttpListenerPoolBase.ThreadPoolManager.Dispose">
<summary>
Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées.
</summary>
<filterpriority>2</filterpriority>
</member>
<member name="P:ServiceStack.AspNet.ServiceStackPage.UnauthorizedRedirectUrl">
<summary>
Default redirct URL if [Authenticate] attribute doesn't permit access.
</summary>
</member>
<member name="P:ServiceStack.AspNet.ServiceStackPage.ForbiddenRedirectUrl">
<summary>
Default redirct URL if Required Role or Permission attributes doesn't permit access.
</summary>
</member>
<member name="T:ServiceStack.AuthenticateAttribute">
<summary>
Indicates that the request dto, which is associated with this attribute,
requires authentication.
</summary>
</member>
<member name="P:ServiceStack.AuthenticateAttribute.Provider">
<summary>
Restrict authentication to a specific <see cref="T:ServiceStack.Auth.IAuthProvider"/>.
For example, if this attribute should only permit access
if the user is authenticated with <see cref="T:ServiceStack.Auth.BasicAuthProvider"/>,
you should set this property to <see cref="F:ServiceStack.Auth.BasicAuthProvider.Name"/>.
</summary>
</member>
<member name="P:ServiceStack.AuthenticateAttribute.HtmlRedirect">
<summary>
Redirect the client to a specific URL if authentication failed.
If this property is null, simply `401 Unauthorized` is returned.
</summary>
</member>
<member name="T:ServiceStack.AuthFeature">
<summary>
Enable the authentication feature and configure the AuthService.
</summary>
</member>
<member name="P:ServiceStack.AuthFeature.CreateDigestAuthHashes">
<summary>
Whether to Create Digest Auth MD5 Hash when Creating/Updating Users.
Defaults to only creating Digest Auth when DigestAuthProvider is registered.
</summary>
</member>
<member name="P:ServiceStack.AuthFeature.SaveUserNamesInLowerCase">
<summary>
Should UserName or Emails be saved in AuthRepository in LowerCase
</summary>
</member>
<member name="T:ServiceStack.Auth.IManageApiKeys">
<summary>
The Interface Auth Repositories need to implement to support API Keys
</summary>
</member>
<member name="T:ServiceStack.Auth.ApiKey">
<summary>
The POCO Table used to persist API Keys
</summary>
</member>
<member name="T:ServiceStack.Auth.ApiKeyAuthProvider">
<summary>
Enable access to protected Services using API Keys
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.ServiceRoutes">
<summary>
Modify the registration of GetApiKeys and RegenerateApiKeys Services
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.KeySizeBytes">
<summary>
How much entropy should the generated keys have. (default 24)
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.Environments">
<summary>
Generate different keys for different environments. (default live,test)
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.KeyTypes">
<summary>
Different types of Keys each user can have. (default secret)
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.ExpireKeysAfter">
<summary>
Whether to automatically expire keys. (default no expiry)
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.InitSchema">
<summary>
Automatically create the ApiKey Table for AuthRepositories which need it. (default true)
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.RequireSecureConnection">
<summary>
Whether to only allow access via API Key from a secure connection. (default true)
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.GenerateApiKey">
<summary>
Change how API Key is generated
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.CreateApiKeyFilter">
<summary>
Run custom filter after API Key is created
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.SessionCacheDuration">
<summary>
Cache the User Session so it can be reused between subsequent API Key Requests
</summary>
</member>
<member name="P:ServiceStack.Auth.ApiKeyAuthProvider.AllowInHttpParams">
<summary>
Whether to allow API Keys in 'apikey' QueryString or FormData
</summary>
</member>
<member name="P:ServiceStack.Auth.AspNetWindowsAuthProvider.AllRoles">
<summary>
Specify all roles to be used by this application
</summary>
</member>
<member name="P:ServiceStack.Auth.AspNetWindowsAuthProvider.LimitAccessToRoles">
<summary>
Only allow access to users in specified roles
</summary>
</member>
<member name="T:ServiceStack.Auth.ValidateFn">
<summary>
Inject logic into existing services by introspecting the request and injecting your own
validation logic. Exceptions thrown will have the same behaviour as if the service threw it.
If a non-null object is returned the request will short-circuit and return that response.
</summary>
<param name="service">The instance of the service</param>
<param name="httpMethod">GET,POST,PUT,DELETE</param>
<param name="requestDto"></param>
<returns>Response DTO; non-null will short-circuit execution and return that response</returns>
</member>
<member name="M:ServiceStack.Auth.AuthenticateService.GetAuthProviders(System.String)">
<summary>
Get AuthProviders Registered in AuthFeature Plugin.
</summary>
<param name="provider">specific provider, or null for all providers</param>
<returns></returns>
<exception cref="T:System.Exception"></exception>
</member>
<member name="M:ServiceStack.Auth.AuthenticateService.GetAuthProvider(System.String)">
<summary>
Get specific AuthProvider
</summary>
<param name="provider"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.AuthenticateService.Authenticate(ServiceStack.Authenticate)">
<summary>
Public API entry point to authenticate via code
</summary>
<param name="request"></param>
<returns>null; if already autenticated otherwise a populated instance of AuthResponse</returns>
</member>
<member name="M:ServiceStack.Auth.AuthenticateService.Authenticate(ServiceStack.Authenticate,System.String,ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthProvider)">
<summary>
The specified <paramref name="session"/> may change as a side-effect of this method. If
subsequent code relies on current <see cref="T:ServiceStack.Auth.IAuthSession"/> data be sure to reload
the session istance via <see cref="M:ServiceStack.ServiceExtensions.GetSession(ServiceStack.IServiceBase,System.Boolean)"/>.
</summary>
</member>
<member name="T:ServiceStack.Auth.AuthEvents">
<summary>
Conveneint base class with empty virtual methods so subclasses only need to override the hooks they need.
</summary>
</member>
<member name="M:ServiceStack.Auth.AuthProvider.FallbackConfig(System.String)">
<summary>
Allows specifying a global fallback config that if exists is formatted with the Provider as the first arg.
E.g. this appSetting with the TwitterAuthProvider:
oauth.CallbackUrl="http://localhost:11001/auth/{0}"
Would result in:
oauth.CallbackUrl="http://localhost:11001/auth/twitter"
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.AuthProvider.Logout(ServiceStack.IServiceBase,ServiceStack.Authenticate)">
<summary>
Remove the Users Session
</summary>
<param name="service"></param>
<param name="request"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Auth.FacebookAuthProvider">
<summary>
Create a Facebook App at: https://developers.facebook.com/apps
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="T:ServiceStack.Auth.GithubAuthProvider">
<summary>
Create an App at: https://github.com/settings/applications/new
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="M:ServiceStack.Auth.AuthHttpGateway.DownloadYammerUserInfo(System.String)">
<summary>
Download Yammer User Info given its ID.
</summary>
<param name="yammerUserId">
The Yammer User ID.
</param>
<returns>
The User info in JSON format.
</returns>
<remarks>
<para>
Yammer provides a method to retrieve current user information via
"https://www.yammer.com/api/v1/users/current.json".
</para>
<para>
However, to ensure consistency with the rest of the Auth codebase,
the explicit URL will be used, where [:id] denotes the User ID:
"https://www.yammer.com/api/v1/users/[:id].json"
</para>
<para>
Refer to: https://developer.yammer.com/restapi/ for full documentation.
</para>
</remarks>
</member>
<member name="M:ServiceStack.Auth.IAuthProvider.Logout(ServiceStack.IServiceBase,ServiceStack.Authenticate)">
<summary>
Remove the Users Session
</summary>
<param name="service"></param>
<param name="request"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.IAuthProvider.Authenticate(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Authenticate)">
<summary>
The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally.
Overridable so you can provide your own Auth implementation.
</summary>
</member>
<member name="M:ServiceStack.Auth.IAuthProvider.IsAuthorized(ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthTokens,ServiceStack.Authenticate)">
<summary>
Determine if the current session is already authenticated with this AuthProvider
</summary>
</member>
<member name="T:ServiceStack.Auth.InMemoryAuthRepository">
<summary>
Thread-safe In memory UserAuth data store so it can be used without a dependency on Redis.
</summary>
</member>
<member name="T:ServiceStack.Auth.JwtAuthProvider">
<summary>
Used to Issue and process JWT Tokens and registers ConvertSessionToToken Service to convert Sessions to JWT Tokens
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProvider.SetBearerTokenOnAuthenticateResponse">
<summary>
Whether to populate the Bearer Token in the AuthenticateResponse
</summary>
</member>
<member name="T:ServiceStack.Auth.JwtAuthProviderReader">
<summary>
Enable access to protected Services using JWT Tokens
</summary>
</member>
<member name="F:ServiceStack.Auth.JwtAuthProviderReader.HmacAlgorithms">
<summary>
Different HMAC Algorithms supported
</summary>
</member>
<member name="F:ServiceStack.Auth.JwtAuthProviderReader.RsaSignAlgorithms">
<summary>
Different RSA Signing Algorithms supported
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.RequireSecureConnection">
<summary>
Whether to only allow access via API Key from a secure connection. (default true)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.CreateHeaderFilter">
<summary>
Run custom filter after JWT Header is created
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.CreatePayloadFilter">
<summary>
Run custom filter after JWT Payload is created
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.PopulateSessionFilter">
<summary>
Run custom filter after session is restored from a JWT Token
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.EncryptPayload">
<summary>
Whether to encrypt JWE Payload (default false).
Uses RSA-OAEP for Key Encryption and AES/128/CBC HMAC SHA256 for Conent Encryption
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.HashAlgorithm">
<summary>
Which Hash Algorithm should be used to sign the JWT Token. (default HS256)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.RequireHashAlgorithm">
<summary>
Whether to only allow processing of JWT Tokens using the configured HashAlgorithm. (default true)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.Issuer">
<summary>
The Issuer to embed in the token. (default ssjwt)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.Audience">
<summary>
The Audience to embed in the token. (default null)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.KeyId">
<summary>
What Id to use to identify the Key used to sign the token. (default First 3 chars of Base64 Key)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.AuthKey">
<summary>
The AuthKey used to sign the JWT Token
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.FallbackAuthKeys">
<summary>
Allow verification using multiple Auth keys
</summary>
</member>
<member name="F:ServiceStack.Auth.JwtAuthProviderReader._privateKey">
<summary>
The RSA Private Key used to Sign the JWT Token when RSA is used
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.PrivateKeyXml">
<summary>
Convenient overload to intialize the Private Key via exported XML
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.PublicKey">
<summary>
The RSA Public Key used to Verify the JWT Token when RSA is used
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.PublicKeyXml">
<summary>
Convenient overload to intialize the Public Key via exported XML
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.FallbackPublicKeys">
<summary>
Allow verification using multiple public keys
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.ExpireTokensIn">
<summary>
How long should JWT Tokens be valid for. (default 14 days)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.ExpireRefreshTokensIn">
<summary>
How long should JWT Refresh Tokens be valid for. (default 365 days)
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.ExpireTokensInDays">
<summary>
Convenient overload to initialize ExpireTokensIn with an Integer
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.ValidateToken">
<summary>
Allow custom logic to invalidate JWT Tokens
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.ValidateRefreshToken">
<summary>
Allow custom logic to invalidate Refresh Tokens
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.InvalidateTokensIssuedBefore">
<summary>
Whether to invalidate all JWT Tokens issued before a specified date.
</summary>
</member>
<member name="P:ServiceStack.Auth.JwtAuthProviderReader.ServiceRoutes">
<summary>
Modify the registration of ConvertSessionToToken Service
</summary>
</member>
<member name="M:ServiceStack.Auth.OAuthProvider.Authenticate(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Authenticate)">
<summary>
The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally.
Overridable so you can provide your own Auth implementation.
</summary>
<param name="authService"></param>
<param name="session"></param>
<param name="request"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.OAuthProvider.Init(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession@,ServiceStack.Authenticate)">
<summary>
Sets the CallbackUrl and session.ReferrerUrl if not set and initializes the session tokens for this AuthProvider
</summary>
<param name="authService"></param>
<param name="session"></param>
<param name="request"> </param>
<returns></returns>
</member>
<member name="T:ServiceStack.Auth.OdnoklassnikiAuthProvider">
<summary>
Create Odnoklassniki App at: http://www.odnoklassniki.ru/devaccess
The Callback URL for your app should match the CallbackUrl provided.
NB: They claim they use OAuth 2.0, but they in fact don't.
http://apiok.ru/wiki/display/api/Authorization+OAuth+2.0
</summary>
</member>
<member name="T:ServiceStack.Auth.Pbkdf2Provider">
<summary>
Allow utilizing an alternative PBKDF2 implementation.
</summary>
</member>
<member name="P:ServiceStack.Auth.Pbkdf2Provider.DeriveKey">
<summary>
The PBKDF2 strategy PasswordHasher implementation that's used for hashing PBKDF2 passwords.
</summary>
</member>
<member name="T:ServiceStack.Auth.PasswordHasher">
<summary>
The Password Hasher provider used to hash users passwords which uses the same algorithm used by ASP.NET Identity v3:
PBKDF2 with HMAC-SHA256, 128-bit salt, 256-bit subkey, 10000 iterations.
</summary>
</member>
<member name="P:ServiceStack.Auth.PasswordHasher.IterationCount">
<summary>
Gets the number of iterations used when hashing passwords using PBKDF2. Default is 10,000.
</summary>
</member>
<member name="M:ServiceStack.Auth.PasswordHasher.#ctor(System.Int32)">
<summary>
The number of iterations used when hashing passwords using PBKDF2. Default is 10,000.
</summary>
</member>
<member name="P:ServiceStack.Auth.PasswordHasher.Version">
<summary>
The Format Version specifier for this PasswordHasher embedded as the first byte in password hashes.
</summary>
</member>
<member name="M:ServiceStack.Auth.PasswordHasher.HashPassword(System.String)">
<summary>
Returns a hashed representation of the supplied <paramref name="password"/> for the specified <paramref name="user"/>.
</summary>
<param name="user">The user whose password is to be hashed.</param>
<param name="password">The password to hash.</param>
<returns>A hashed representation of the supplied <paramref name="password"/> for the specified <paramref name="user"/>.</returns>
</member>
<member name="T:ServiceStack.Auth.KeyDerivationPrf">
<summary>
Specifies the PRF which should be used for the key derivation algorithm.
</summary>
</member>
<member name="F:ServiceStack.Auth.KeyDerivationPrf.HMACSHA1">
<summary>
The HMAC algorithm (RFC 2104) using the SHA-1 hash function (FIPS 180-4).
</summary>
</member>
<member name="F:ServiceStack.Auth.KeyDerivationPrf.HMACSHA256">
<summary>
The HMAC algorithm (RFC 2104) using the SHA-256 hash function (FIPS 180-4).
</summary>
</member>
<member name="F:ServiceStack.Auth.KeyDerivationPrf.HMACSHA512">
<summary>
The HMAC algorithm (RFC 2104) using the SHA-512 hash function (FIPS 180-4).
</summary>
</member>
<member name="T:ServiceStack.Auth.KeyDerivation">
<summary>
Provides algorithms for performing key derivation.
</summary>
</member>
<member name="M:ServiceStack.Auth.KeyDerivation.Pbkdf2(System.String,System.Byte[],ServiceStack.Auth.KeyDerivationPrf,System.Int32,System.Int32)">
<summary>
Performs key derivation using the PBKDF2 algorithm.
</summary>
<param name="password">The password from which to derive the key.</param>
<param name="salt">The salt to be used during the key derivation process.</param>
<param name="prf">The pseudo-random function to be used in the key derivation process.</param>
<param name="iterationCount">The number of iterations of the pseudo-random function to apply
during the key derivation process.</param>
<param name="numBytesRequested">The desired length (in bytes) of the derived key.</param>
<returns>The derived key.</returns>
<remarks>
The PBKDF2 algorithm is specified in RFC 2898.
</remarks>
</member>
<member name="T:ServiceStack.Auth.IPbkdf2Provider">
<summary>
Internal interface used for abstracting away the PBKDF2 implementation since the implementation is OS-specific.
</summary>
</member>
<member name="T:ServiceStack.Auth.ManagedPbkdf2Provider">
<summary>
A PBKDF2 provider which utilizes the managed hash algorithm classes as PRFs.
This isn't the preferred provider since the implementation is slow, but it is provided as a fallback.
</summary>
</member>
<member name="M:ServiceStack.Auth.RegisterService.Put(ServiceStack.Register)">
<summary>
Update an existing registraiton
</summary>
</member>
<member name="M:ServiceStack.Auth.RegisterService.Post(ServiceStack.Register)">
<summary>
Create new Registration
</summary>
</member>
<member name="M:ServiceStack.Auth.RegisterService.UpdateUserAuth(ServiceStack.Register)">
<summary>
Logic to update UserAuth from Registration info, not enabled on PUT because of security.
</summary>
</member>
<member name="T:ServiceStack.Auth.SaltedHash">
<summary>
Thank you Martijn
http://www.dijksterhuis.org/creating-salted-hash-values-in-c/
Stronger/Slower Alternative:
https://github.com/defuse/password-hashing/blob/master/PasswordStorage.cs
</summary>
</member>
<member name="T:ServiceStack.Auth.TwitterAuthProvider">
<summary>
Create an app at https://dev.twitter.com/apps to get your ConsumerKey and ConsumerSecret for your app.
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="M:ServiceStack.Auth.UserAuthRepositoryExtensions.AssignRoles(ServiceStack.Auth.IAuthRepository,ServiceStack.Auth.IUserAuth,System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.String})">
<summary>
Creates the required missing tables or DB schema
</summary>
</member>
<member name="T:ServiceStack.Auth.VkAuthProvider">
<summary>
Create VK App at: http://vk.com/editapp?act=create
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="M:ServiceStack.Auth.VkAuthProvider.EnsureLatestCode(System.String)">
<summary>
If previous attemts failes, the subsequential calls
build up code value like "code1,code2,code3"
so we need the last one only
</summary>
<param name="code"></param>
<returns></returns>
</member>
<member name="T:ServiceStack.Auth.YammerAuthProvider">
<summary>
The ServiceStack Yammer OAuth provider.
</summary>
<remarks>
<para>
This provider is loosely based on the existing ServiceStack's Facebook OAuth provider.
</para>
<para>
For the full info on Yammer's OAuth2 authentication flow, refer to:
https://developer.yammer.com/authentication/#a-oauth2
</para>
<para>
Note: Add these to your application / web config settings under appSettings and replace
values as appropriate.
<![CDATA[
<!-- ServiceStack Yammer OAuth config -->
<add key="oauth.yammer.ClientId" value=""/>
<add key="oauth.yammer.ClientSecret" value=""/>
<add key="oauth.yammer.AccessTokenUrl" value="https://www.yammer.com/oauth2/access_token.json"/>
<add key="oauth.yammer.CallbackUrl" value="~/"/>
<add key="oauth.yammer.PreAuthUrl" value="https://www.yammer.com/dialog/oauth"/>
<add key="oauth.yammer.Realm" value="https://www.yammer.com"/>
<add key="oauth.yammer.RedirectUrl" value="~/auth/yammer"/>
]]>
</para>
</remarks>
</member>
<member name="F:ServiceStack.Auth.YammerAuthProvider.Name">
<summary>
The OAuth provider name / identifier.
</summary>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.#ctor(ServiceStack.Configuration.IAppSettings)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Auth.YammerAuthProvider"/> class.
</summary>
<param name="appSettings">
The application settings (in web.config).
</param>
</member>
<member name="P:ServiceStack.Auth.YammerAuthProvider.ClientId">
<summary>
Gets or sets the Yammer OAuth client id.
</summary>
</member>
<member name="P:ServiceStack.Auth.YammerAuthProvider.ClientSecret">
<summary>
Gets or sets the Yammer OAuth client secret.
</summary>
</member>
<member name="P:ServiceStack.Auth.YammerAuthProvider.PreAuthUrl">
<summary>
Gets or sets the Yammer OAuth pre-auth url.
</summary>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.Authenticate(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Authenticate)">
<summary>
Authenticate against Yammer OAuth endpoint.
</summary>
<param name="authService">
The auth service.
</param>
<param name="session">
The session.
</param>
<param name="request">
The request.
</param>
<returns>
The <see cref="T:System.Object"/>.
</returns>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.LoadUserAuthInfo(ServiceStack.AuthUserSession,ServiceStack.Auth.IAuthTokens,System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Load the UserAuth info into the session.
</summary>
<param name="userSession">
The User session.
</param>
<param name="tokens">
The OAuth tokens.
</param>
<param name="authInfo">
The auth info.
</param>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.LoadUserOAuthProvider(ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthTokens)">
<summary>
Load the UserOAuth info into the session.
</summary>
<param name="authSession">
The auth session.
</param>
<param name="tokens">
The OAuth tokens.
</param>
</member>
<member name="T:ServiceStack.Auth.EmailAddresses">
<summary>
The Yammer User's email addresses.
</summary>
</member>
<member name="P:ServiceStack.Auth.EmailAddresses.Type">
<summary>
Gets or sets the email address type (e.g. primary).
</summary>
</member>
<member name="P:ServiceStack.Auth.EmailAddresses.Address">
<summary>
Gets or sets the email address.
</summary>
</member>
<member name="T:ServiceStack.Auth.YandexAuthProvider">
<summary>
Create Yandex App at: https://oauth.yandex.ru/client/new
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.ServiceBaseUrl">
<summary>
The BaseUrl of the ServiceStack instance (inferred)
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.ServiceName">
<summary>
Name of the ServiceStack Instance (inferred)
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.ServiceDescription">
<summary>
Textual description of the AutoQuery Services (shown in Home Services list)
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.ServiceIconUrl">
<summary>
Icon for this ServiceStack Instance (shown in Home Services list)
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.Formats">
<summary>
The different Content Type formats to display
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.MaxLimit">
<summary>
The configured MaxLimit for AutoQuery
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.IsPublic">
<summary>
Whether to publish this Service to the public Services registry
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.OnlyShowAnnotatedServices">
<summary>
Only show AutoQuery Services attributed with [AutoQueryViewer]
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.ImplicitConventions">
<summary>
List of different Search Filters available
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.DefaultSearchField">
<summary>
The Column which should be selected by default
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.DefaultSearchType">
<summary>
The Query Type filter which should be selected by default
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.DefaultSearchText">
<summary>
The search text which should be populated by default
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.BrandUrl">
<summary>
Link to your website users can click to find out more about you
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.BrandImageUrl">
<summary>
A custom logo or image that users can click on to visit your site
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.TextColor">
<summary>
The default color of text
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.LinkColor">
<summary>
The default color of links
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.BackgroundColor">
<summary>
The default background color of each screen
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.BackgroundImageUrl">
<summary>
The default background image of each screen anchored to the bottom left
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerConfig.IconUrl">
<summary>
The default icon for each of your AutoQuery Services
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerUserInfo.IsAuthenticated">
<summary>
Returns true if the User Is Authenticated
</summary>
</member>
<member name="P:ServiceStack.AutoQueryViewerUserInfo.QueryCount">
<summary>
How many queries are available to this user
</summary>
</member>
<member name="M:ServiceStack.CacheClientExtensions.RemoveByPattern(ServiceStack.Caching.ICacheClient,System.String)">
<summary>
Removes items from cache that have keys matching the specified wildcard pattern
</summary>
<param name="cacheClient">Cache client</param>
<param name="pattern">The wildcard, where "*" means any sequence of characters and "?" means any single character.</param>
</member>
<member name="M:ServiceStack.CacheClientExtensions.RemoveByRegex(ServiceStack.Caching.ICacheClient,System.String)">
<summary>
Removes items from the cache based on the specified regular expression pattern
</summary>
<param name="cacheClient">Cache client</param>
<param name="regex">Regular expression pattern to search cache keys</param>
</member>
<member name="P:ServiceStack.CacheInfo.CacheKey">
<summary>
The CacheKey to be use store the response against
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.KeyBase">
<summary>
The base Cache Key used to cache the Service response
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.KeyModifiers">
<summary>
Additional CacheKey Modifiers used to cache different outputs for a single Service Response
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.ExpiresIn">
<summary>
How long to cache the resource for. Fallsback to HttpCacheFeature.DefaultExpiresIn
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.ETag">
<summary>
The unique ETag returned for this resource clients can use to determine whether their local version has changed
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.Age">
<summary>
The Age for this resource returned to clients
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.MaxAge">
<summary>
The MaxAge returned to clients to indicate how long they can use their local cache before re-validating
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.LastModified">
<summary>
The LastModified date to use for the Cache and HTTP Header
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.CacheControl">
<summary>
Cache-Control HTTP Headers
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.VaryByUser">
<summary>
Create unique cache per user
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.LocalCache">
<summary>
Use HostContext.LocalCache or HostContext.Cache
</summary>
</member>
<member name="P:ServiceStack.CacheInfo.NoCompression">
<summary>
Skip compression for this Cache Result
</summary>
</member>
<member name="T:ServiceStack.CacheResponseAttribute">
<summary>
Cache the Response of a Service
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.Duration">
<summary>
Cache expiry in seconds
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.MaxAge">
<summary>
MaxAge in seconds
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.CacheControl">
<summary>
Cache-Control HTTP Headers
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.VaryByUser">
<summary>
Vary cache per user
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.VaryByRoles">
<summary>
Vary cache for users in these roles
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.VaryByHeaders">
<summary>
Vary cache for different HTTP Headers
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.LocalCache">
<summary>
Use HostContext.LocalCache or HostContext.Cache
</summary>
</member>
<member name="P:ServiceStack.CacheResponseAttribute.NoCompression">
<summary>
Skip compression for this Cache Result
</summary>
</member>
<member name="T:ServiceStack.Caching.CacheClientWithPrefix">
<summary>
Decorates the ICacheClient (and its sibblings) prefixing every key with the given prefix
Usefull for multi-tenant environments
</summary>
</member>
<member name="M:ServiceStack.Caching.CacheClientWithPrefixExtensions.WithPrefix(ServiceStack.Caching.ICacheClient,System.String)">
<summary>
Decorates the ICacheClient (and its sibblings) prefixing every key with the given prefix
Usefull for multi-tenant environments
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheEntry.#ctor(System.Object,System.Nullable{System.DateTime})">
<summary>
Create new instance of CacheEntry.
</summary>
</member>
<member name="P:ServiceStack.Caching.MemoryCacheClient.CacheEntry.ExpiresAt">
<summary>UTC time at which CacheEntry expires.</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheAdd(System.String,System.Object,System.Nullable{System.DateTime})">
<summary>
Stores The value with key only if such key doesn't exist at the server yet.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheSet(System.String,System.Object,System.DateTime)">
<summary>
Adds or replaces the value with key.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheSet(System.String,System.Object,System.Nullable{System.DateTime},System.Nullable{System.Int64})">
<summary>
Adds or replaces the value with key.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheReplace(System.String,System.Object,System.Nullable{System.DateTime})">
<summary>
Replace the value with specified key if it exists.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Add``1(System.String,``0)">
<summary>
Add the value with key to the cache, set to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Set``1(System.String,``0)">
<summary>
Add or replace the value with key to the cache, set to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Replace``1(System.String,``0)">
<summary>
Replace the value with key in the cache, set to never expire.
</summary>