Skip to content

Commit 715fe6e

Browse files
authored
Update README.md
1 parent 4f22941 commit 715fe6e

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

README.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# KeyAuth-Python-Example
22
KeyAuth Python Example For The https://keyauth.cc Authentication system.
33

4-
**What is KeyAuth?**
4+
#### **Bugs**
55

6-
KeyAuth is an Open source authentication system with cloud hosting plans as well. Client SDKs available for C++, C#, Python, Rust, PHP, JS, GO, Ruby and VB.NET. KeyAuth has several unique features such as memory streaming, webhook function where you can send requests to API without leaking the API, discord webhook notifications, ban the user securely through the application at your discretion. Feel free to join https://discord.gg/keyauth If you are experiencing account issues.
6+
If the default example not added to your software isn't functioning how it should, please join the Discord server https://discord.gg/keyauth and submit the issue in the `#bugs` channel.
77

8-
**Customer connection issues?**
8+
However, we do **NOT** provide support for adding KeyAuth to your project. If you can't figure this out you should use Google or YouTube to learn more about the programming language you want to sell a program in.
9+
10+
#### **What is KeyAuth?**
11+
12+
KeyAuth is an Open source authentication system with cloud hosting plans as well. Client SDKs available for [C#](https://github.com/KeyAuth/KeyAuth-CSHARP-Example), [C++](https://github.com/KeyAuth/KeyAuth-CPP-Example), [Python](https://github.com/KeyAuth/KeyAuth-Python-Example), [Java](https://github.com/SprayDown/KeyAuth-JAVA-api), [JavaScript](https://github.com/mazkdevf/KeyAuth-JS-Example), [VB.NET](https://github.com/KeyAuth/KeyAuth-VB-Example), [PHP](https://github.com/KeyAuth/KeyAuth-PHP-Example), [Rust](https://github.com/KeyAuth/KeyAuth-Rust-Example), [Go](https://github.com/mazkdevf/KeyAuth-Go-Example), [Lua](https://github.com/mazkdevf/KeyAuth-Lua-Examples), [Ruby](https://github.com/mazkdevf/KeyAuth-Ruby-Example), and [Perl](https://github.com/mazkdevf/KeyAuth-Perl-Example). KeyAuth has several unique features such as memory streaming, webhook function where you can send requests to API without leaking the API, discord webhook notifications, ban the user securely through the application at your discretion. Feel free to join https://discord.gg/keyauth if you have questions or suggestions.
13+
14+
#### **Customer connection issues?**
915

1016
This is common amongst all authentication systems. Program obfuscation causes false positives in virus scanners, and with the scale of KeyAuth this is perceived as a malicious domain. So, `keyauth.com` and `keyauth.win` have been blocked by many internet providers. for dashbord, reseller panel, customer panel, use `keyauth.cc`
1117

1218
For API, `keyauth.cc` will not work because I purposefully blocked it on there so `keyauth.cc` doesn't get blocked also. So, you should create your own domain and follow this tutorial video https://www.youtube.com/watch?v=a2SROFJ0eYc. The tutorial video shows you how to create a domain name for 100% free if you don't want to purchase one.
1319

14-
**`KeyAuthApp` instance definition**
20+
#### **`KeyAuthApp` instance definition**
1521

1622
Visit and select your application, then click on the **Python** tab
1723

@@ -27,11 +33,11 @@ keyauthapp = api(
2733
)
2834
```
2935

30-
**Initialize application**
36+
#### **Initialize application**
3137

3238
You don't need to add any code to initalize. KeyAuth will initalize when the instance definition is made.
3339

34-
**Display application information**
40+
#### **Display application information**
3541

3642
```py
3743
print(f"""
@@ -44,15 +50,15 @@ Customer panel link: {keyauthapp.app_data.customer_panel}
4450
""")
4551
```
4652

47-
**Check session validation**
53+
#### **Check session validation**
4854

4955
Use this to see if the user is logged in or not.
5056

5157
```py
5258
print(f"Current Session Validation Status: {keyauthapp.check()}")
5359
```
5460

55-
**Check blacklist status**
61+
#### **Check blacklist status**
5662

5763
Check if HWID or IP Address is blacklisted. You can add this if you want, just to make sure nobody can open your program for less than a second if they're blacklisted. Though, if you don't mind a blacklisted user having the program for a few seconds until they try to login and register, and you care about having the quickest program for your users, you shouldn't use this function then. If a blacklisted user tries to login/register, the KeyAuth server will check if they're blacklisted and deny entry if so. So the check blacklist function is just auxiliary function that's optional.
5864

@@ -62,15 +68,15 @@ if keyauthapp.checkblacklist():
6268
os._exit(1)
6369
```
6470

65-
**Login with username/password**
71+
#### **Login with username/password**
6672

6773
```py
6874
user = input('Provide username: ')
6975
password = input('Provide password: ')
7076
keyauthapp.login(user, password)
7177
```
7278

73-
**Register with username/password/key**
79+
#### **Register with username/password/key**
7480

7581
```py
7682
user = input('Provide username: ')
@@ -79,7 +85,7 @@ license = input('Provide License: ')
7985
keyauthapp.register(user, password, license)
8086
```
8187

82-
**Upgrade user username/key**
88+
#### **Upgrade user username/key**
8389

8490
Used so the user can add extra time to their account by claiming new key.
8591

@@ -92,7 +98,7 @@ license = input('Provide License: ')
9298
keyauthapp.upgrade(user, license)
9399
```
94100

95-
**Login with just license key**
101+
#### **Login with just license key**
96102

97103
Users can use this function if their license key has never been used before, and if it has been used before. So if you plan to just allow users to use keys, you can remove the login and register functions from your code.
98104

@@ -101,7 +107,7 @@ key = input('Enter your license: ')
101107
keyauthapp.license(key)
102108
```
103109

104-
**User Data**
110+
#### **User Data**
105111

106112
Show information for current logged-in user.
107113

@@ -125,7 +131,7 @@ print("Expires at: " + datetime.utcfromtimestamp(int(keyauthapp.user_data.expire
125131
print(f"Current Session Validation Status: {keyauthapp.check()}")
126132
```
127133

128-
**Show list of online users**
134+
#### **Show list of online users**
129135

130136
```py
131137
onlineUsers = keyauthapp.fetchOnline()
@@ -139,7 +145,7 @@ else:
139145
print("\n" + OU + "\n")
140146
```
141147

142-
**Application variables**
148+
#### **Application variables**
143149

144150
A string that is kept on the server-side of KeyAuth. On the dashboard you can choose for each variable to be authenticated (only logged in users can access), or not authenticated (any user can access before login). These are global and static for all users, unlike User Variables which will be dicussed below this section.
145151

@@ -149,7 +155,7 @@ data = keyauthapp.var("varName")
149155
print(data)
150156
```
151157

152-
**User Variables**
158+
#### **User Variables**
153159

154160
User variables are strings kept on the server-side of KeyAuth. They are specific to users. They can be set on Dashboard in the Users tab, via SellerAPI, or via your loader using the code below. `discord` is the user variable name you fetch the user variable by. `test#0001` is the variable data you get when fetching the user variable.
155161

@@ -166,7 +172,7 @@ data = keyauthapp.getvar("varName")
166172
print(data)
167173
```
168174

169-
**Application Logs**
175+
#### **Application Logs**
170176

171177
Can be used to log data. Good for anti-debug alerts and maybe error debugging. If you set Discord webhook in the app settings of the Dashboard, it will send log messages to your Discord webhook rather than store them on site. It's recommended that you set Discord webhook, as logs on site may be deleted after a couple months of their creation.
172178

@@ -177,7 +183,7 @@ You can use the log function before login & after login.
177183
keyauthapp.log("Message")
178184
```
179185

180-
**Ban the user**
186+
#### **Ban the user**
181187

182188
Ban the user and blacklist their HWID and IP Address. Good function to call upon if you use anti-debug and have detected an intrusion attempt.
183189

@@ -187,7 +193,7 @@ Function only works after login.
187193
keyauthapp.ban()
188194
```
189195

190-
**Server-sided webhooks**
196+
#### **Server-sided webhooks**
191197

192198
Tutorial video https://www.youtube.com/watch?v=ENRaNPPYJbc
193199

@@ -210,7 +216,7 @@ data = keyauthapp.webhook("7kR0UedlVI", "", "type=init&name=test&ownerid=j9Gj0FT
210216
data = keyauthapp.webhook("7kR0UedlVI", "", "{\"content\": \"webhook message here\",\"embeds\": null}", "application/json")
211217
```
212218

213-
**Download file**
219+
#### **Download file**
214220

215221
Keep files secure by providing KeyAuth your file download link on the KeyAuth dashboard. Make sure this is a direct download link (as soon as you go to the link, it starts downloading without you clicking anything). The KeyAuth download function provides the bytes, and then you get to decide what to do with those. This example shows how to write it to a file named `text.txt` in the same folder as the program, though you could execute with RunPE or whatever you want.
216222

@@ -224,7 +230,7 @@ f.write(bytes)
224230
f.close()
225231
```
226232

227-
**Chat channels**
233+
#### **Chat channels**
228234

229235
Allow users to communicate amongst themselves in your program.
230236

@@ -248,7 +254,7 @@ Example on how to send chat message.
248254
keyauthapp.chatSend("MESSAGE", "CHANNEL")
249255
```
250256

251-
**How to compile?**
257+
#### **How to compile?**
252258

253259
You can either use Pyinstaller or Nuitka.
254260

0 commit comments

Comments
 (0)